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

Web APIs in example should follow RESTful style #915

Closed
pfwang80s opened this issue Oct 24, 2023 · 3 comments
Closed

Web APIs in example should follow RESTful style #915

pfwang80s opened this issue Oct 24, 2023 · 3 comments

Comments

@pfwang80s
Copy link
Contributor

pfwang80s commented Oct 24, 2023 •
edited
Loading

e.g.:

  • /add_learner should be POST /learners
  • /write should be POST or PUT /data/keys, actually, POST / PUT have different semantics, POST means new an item, PUT means modify
  • /consistent_read should be GET /data/keys/<key>
@github-actions
Copy link

👋 Thanks for opening this issue!

Get help or engage by:

  • /help : to print help messages.
  • /assignme : to assign this issue to you.

@drmingdrmer
Copy link
Member

Restful is more like a guideline, not a syntax rule.
what the style it is doesn't matter unless it is misleading.
I'd like it to be more explicit about what it's doing.

@drmingdrmer
Copy link
Member

Close this issue. If you have any questions, please feel free to reopen it.

@drmingdrmer drmingdrmer reopened this Oct 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@drmingdrmer @pfwang80s