Skip to content

Latest commit

 

History

History
44 lines (31 loc) · 2.21 KB

README.md

File metadata and controls

44 lines (31 loc) · 2.21 KB
Raw

httpstatuscodes.io

httpstatuscodes.io is an easy to reference database of HTTP Status Codes with their definitions and helpful code references, each code is at httpstatuscodes.io/{code}. All standard codes are included, as are some non-standard codes that have significant presence in the wild. A JSON endpoint is available for every code at httpstatuscodes.io/{code}.json.

Examples

https://httpstatuscodes.io/200

https://httpstatuscodes.io/200.json

Development

The application currently runs on ASP.NET 6 with Razor Pages.

Run npm install to pull in dependencies and then node build to create the style.css file.

Run the application using dotnet run --project src/Fluxera.HttpStatusCodes The application is available locally.

Contributing

All contributions are welcome! If you have an idea to improve the website please submit a pull request or create an issue, or provide your thoughts on open issues.

Each status code lives in a Markdown file at contents/codes, the easiest way to submit changes is via the GitHub editor. When contributing changes to the status codes please be mindful of the following:

  • Markdown links should be used as references instead of inline
  • If an RFC or external document is referenced, make the reference a link
  • Source information on a status code from the most recent standards available (Status Code standards directory is available on iana.org)
  • The opening paragraph of a status code should describe the meaning, following paragraphs can describe implementation
  • Don't edit the meaning of descriptions, but formatting and structural changes are a-okay
  • Don't double-space after a period, and remove any examples of it
  • If the description references a section in the current RFC, always add the RFC identifier. For example "Section 6.6" should become "RFC1234 Section 6.6"