apinf / docs

Documentation for the Apinf API Dashboard project.

Creative Commons Zero v1.0 Universal

1 stars 5 forks source link

Create APInf REST API guidelines #68

Closed mauriciovieira closed 7 years ago

mauriciovieira commented 7 years ago

Description at https://github.com/apinf/platform/issues/2809

References

Zalando REST API guidelines
Blog post about API guidelines
http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api
http://apistylebook.com/design/guidelines/
Classic https://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm

mauriciovieira commented 7 years ago

@matleppa @Nazarah would https://github.com/apinf/docs/tree/master/docs/develop be the best place to store these guidelines?

Nazarah commented 7 years ago

@matleppa I don't see any problem with it. :)

mauriciovieira commented 7 years ago

From https://github.com/apinf/platform/issues/2336#issuecomment-301167599, @frenchbread

'd suggest we go simple and create something similar to RESTful SailsJS blueprint-api pattern. API-wise this concept has all needed features that APInf might need.