mirror of
https://github.com/rmaake1/httpstatuses.git
synced 2024-09-15 14:02:37 +02:00
dd76089270
Removed the unused helper, moved to composer because of the dependency on klein.php, cleaned up the readme, added a proper robots.txt (allow all indexing) and removed some unused files (.gitattributes, .gitignore, assets/css/style.css)
2.3 KiB
2.3 KiB
httpstatus.es is an easy to use http status code reference site. An individual code can be accessed via httpstatus.es/{status_code}.
Each individual code is stored in a file specific to the class it is a part of. For example 404 is stored in 4.json, along with all other 4xx codes.
json format
{
"class":{
"title":"1xx Informational"
},
"codes":{
"100":{
"title":"Continue",
"summary":"Client should continue with request",
"descriptions":{
"wiki":{
"body":"Wikipedia description",
"link":"http:\/\/en.wikipedia.org\/wiki\/List_of_HTTP_status_codes#100"
},
"ietf":{
"body":"IETF Description",
"link":"http:\/\/www.ietf.org\/rfc\/rfc2616.txt"
}
},
"references":{
"item":{
"title":"Reference Title",
"value":"Reference Value"
},
"item2":{
"title":"Reference Title",
"value":"Reference Value"
}
}
}
}
}
JSON should be formatted as above using four space tab and \r\n for new lines in descriptions. There is no validation on the output and the only processing is turning new lines into line breaks, if you wish to include HTML that's fine (preferably only links though and code tags).
to do
- clean up the HTML and CSS
- Add some sort of "global reference" system, where a code reference can be added that applies to all status codes based on a property, eg: adding an http status cats (http://httpcats.herokuapp.com/) link to each code page
- configure httpstatuses.com to redirect
- Decide on whether or not to add a method to return a specific class of error codes, eg: 4xx, 5xx. Not sure if httpstatus.es/{class} makes sense (eg: httpstatus.es/5) or httpstatus.es/{class}xx (eg: httpstatus.es/5xx)
- Some sort of templating, why have I got the (uniform) head in 3 separate views!
- Languages?
notes
httpstatus.es is built with klein.php and designed by myself. This is my first attempt at open sourcing anything that I have made.