Sitelet https://web.archive.org/web/20220610095542/https://github.com/gothinkster/realworld/issues/713
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.

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

[V2][Backend] API endpoints changes #713

Open
geromegrignon opened this issue Aug 24, 2021 · 3 comments
Open

[V2][Backend] API endpoints changes #713

geromegrignon opened this issue Aug 24, 2021 · 3 comments
Labels
good first issue help wanted Status: Approved

Comments

@geromegrignon
Copy link
Contributor

@geromegrignon geromegrignon commented Aug 24, 2021 •
edited

The V2 is a great opportunity to review the specs.

Here is an RFC for URL and verbs used on the backend specs:

Login user

POST /api/users/login

Register user

POST /api/users

Get current user

GET /api/user

Proposal: change the URL to /api/users/me (consistency on users)

Update user

PUT /api/user

Proposal: change the URL to /api/users (consistency on users)

Get profile

GET /api/profiles/:username

Follow user

POST /api/profiles/:username/follow

#582 Proposal: change the verb to PUT (as it creates a relation link)

Unfollow user

DELETE /api/profiles/:username/follow

Get articles

GET /api/articles

Get feed articles

GET /api/articles/feed

#695 Proposal: change the URL to /api/feed (to avoid conflict with /api/articles/:slug with a feed param)

Get article

GET /api/articles/:slug

Create article

POST /api/articles

Update article

PUT /api/articles/:slug

Delete article

DELETE /api/articles/:slug

Add comments to an article

POST /api/articles/:slug/comments

Get comments from an article

GET /api/articles/:slug/comments

Delete Comment

DELETE /api/articles/:slug/comments/:id

Favorite article

POST /api/articles/:slug/favorite

Proposal: change the verb to PUT (as it creates a relation link)

Unfavorite article

DELETE /api/articles/:slug/favorite

Get tags

GET /api/tags
@geromegrignon geromegrignon mentioned this issue Aug 29, 2021
Closed
@geromegrignon geromegrignon mentioned this issue Aug 30, 2021
Closed
@geromegrignon geromegrignon changed the title [V2][Backend][RFC] API endpoints changes [V2][Backend] API endpoints changes Nov 6, 2021
@geromegrignon
Copy link
Contributor Author

@geromegrignon geromegrignon commented Nov 6, 2021

This task is now open for contributions to the API documentation ( I'll open contributions to the API itself soon).

Based on the v2 branch of this repository, changes have to be made upon the OpenAPI file.

You can preview changes by importing the yml file in Swagger Editor.

@geromegrignon geromegrignon mentioned this issue Nov 15, 2021
Open
@geromegrignon geromegrignon added the Status: Approved label Nov 15, 2021
@conradylx
Copy link

@conradylx conradylx commented May 7, 2022

Is this task still available?

@geromegrignon
Copy link
Contributor Author

@geromegrignon geromegrignon commented Jun 6, 2022

Is this task still available?

Hello, sorry for the delay.
Yes, it's still available (please note proposals related to 582 and 695 are already done on the v2 branch).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue help wanted Status: Approved
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@geromegrignon @conradylx