Design API documentation - Githubissues

RunpengNie / underdog-s-struggling

From 0 to 1, and then from 1 to 100.

0 stars 0 forks source link

Design API documentation #8

Open Junzhou-712 opened 9 months ago

Junzhou-712 commented 9 months ago

We should have a basic API docs for backend design. Generally, it has had 2 services so far

auth service(considered about JWT feature)[AuthController]
docs services [DocServiceController]

RunpengNie commented 8 months ago

Exactly, let me expand on the two points you mentioned:

auth service(considered about JWT feature)
- User creates an account
- User/Admin login
- User/Admin logout
- Automatically log out after the voucher/token expires
- User pays for subscription[FAR future feature]
docs services
- Admin creates an Entry
- Admin updates an Entry
- Admin removes an Entry
- Display entry level Entries[Joe]
- Display medium level Entries[Joe]
- Display advance level Entries[Joe]
- Display [Topic] page (topic is a parameter)[Tony]
- Display by [Tag] (tag is a parameter)[Tony]
- Display all entries/Interview mode[Tony]
- Search by tag/title/subtitle[Tony]
- Search by relevance[hardest, low priority] Any ideas? @TonyLiu836 @VincentXiao997 @Junzhou-712