Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

RESTful endpoint naming

Open
  • Is something wrong?
#151 0 comments 0 reactions 1 assignee View on GitHub

@sima-qian is already working on this.

Since Oct 19, 2018.

Assessment

This issue has not been assessed yet.

Description

server

Endpoints like app.get("/api/history/:station") and app.get("/api/history/:station/case/:id") are well-named but ones like app.post("/api/add-case/:station") are a little confusing.

Generally it is good to try and only refer to the resource name in the end point and then specify the behaviour you want with the HTTP verb. So adding a case to a station would be via a POST to something like /api/stations/:stationId/case.

Dominant language
JavaScript
Stars
4
Forks
2
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from fac-14/OSCEBossKey

All issues in fac-14/OSCEBossKey

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.