Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

確認 API-Spec #9

Open
skyhong2002 opened this issue Oct 12, 2022 · 10 comments
Open

確認 API-Spec #9

skyhong2002 opened this issue Oct 12, 2022 · 10 comments
Assignees
@JacobLinCool
Labels
help wanted Extra attention is needed

Comments

@skyhong2002
Copy link
Member

skyhong2002 commented Oct 12, 2022 •
edited
Loading

No description provided.

@skyhong2002
Copy link
Member Author

確認這個 Spec 是否還是對的：
https://unicourse-tw.github.io/API-Spec/

@skyhong2002 skyhong2002 added the help wanted Extra attention is needed label Oct 13, 2022
@skyhong2002 skyhong2002 moved this from 📋 Backlog to 🔖 Ready in UniCourse Roadmap Oct 14, 2022
@skyhong2002
Copy link
Member Author

想請問 @uier @JacobLinCool 確認 API-Spec 想要怎麼進行？ 因為牽扯到的東西蠻多的，Jacob 也有提到目前有不少東西和 Spec 不同，有實作上ㄉ困難

@skyhong2002 skyhong2002 moved this from 🔖 Ready to 💬 Discussing in UniCourse Roadmap Oct 20, 2022
@uier
Copy link
Contributor

uier commented Oct 24, 2022

想請問 @uier @JacobLinCool 確認 API-Spec 想要怎麼進行？ 因為牽扯到的東西蠻多的，Jacob 也有提到目前有不少東西和 Spec 不同，有實作上ㄉ困難

是的我也有這個疑問，目前開發主要的推動力是 @JacobLinCool ，所以我想聽聽 Jacob 的看法

我自己想到的方法是可以先分類 API，例如：

  1. 可以完全不動繼續留在 Spec 的
  2. 需要改 request/respond body 的
  3. 需要重新設計的

@uier
Copy link
Contributor

uier commented Oct 24, 2022 •
edited
Loading

我想 Jacob 把 Spec 一眼看過去應該可以 O(1) 得出每個 API 是否是 2, 3 類（？

@skyhong2002
Copy link
Member Author

會需要動的地方 by @JacobLinCool

  • 課程
    • 所屬單位，會和 course/courses 高度重疊

@skyhong2002
Copy link
Member Author

@JacobLinCool 會做完後端 MVP 後釋出 UniCrouse SDK Client 端的 library，不用先確認

@JacobLinCool
Copy link
Member

https://www.npmjs.com/package/unicourse

@skyhong2002 skyhong2002 moved this from 💬 Discussing to 👀 In review in UniCourse Roadmap Nov 4, 2022
@skyhong2002 skyhong2002 moved this from 👀 In review to 📋 Backlog in UniCourse Roadmap Nov 6, 2022
@skyhong2002
Copy link
Member Author

（上面的文件已經過時了，不要參考）

@skyhong2002 skyhong2002 moved this from 📋 Backlog to 🏗 In progress in UniCourse Roadmap Nov 18, 2022
@skyhong2002
Copy link
Member Author

短期 SDK 的文件比較重要（ @DWyatb 需要和後端互動

API-Spec 未來可以使用 Prisma 自動生成 OpenAPI 格式的文件，但並不會是完全準確（？）

@skyhong2002 skyhong2002 moved this from 🏗 In progress to 📋 Backlog in UniCourse Roadmap Nov 20, 2022
@skyhong2002 skyhong2002 moved this from 📋 Backlog to 💬 Discussing in UniCourse Roadmap Nov 25, 2022
@skyhong2002
Copy link
Member Author

This issue has not been updated for a while. Request @JacobLinCool to update.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JacobLinCool JacobLinCool

Labels
help wanted Extra attention is needed
Projects
UniCourse Roadmap
Status: 💬 Discussing
Milestone
No milestone
Development

No branches or pull requests
3 participants
@uier @JacobLinCool @skyhong2002