Develop API documentation for the new API endpoints

opensrp / opensrp-server-web

OpenSRP Server Generic Web Application

Other

10 stars 22 forks source link

Develop API documentation for the new API endpoints #19

Open craigappl opened 6 years ago

craigappl commented 6 years ago

We need to develop documentation using an API documentation generator that defines the OpenSRP server API endpoints that are being added for Reveal. There are a number of tools out there and we need to:

Decide on a standard (OpenAPI vs RAML) Identify an appropriate library to use (Swagger, ReDOC, RAML console) Write the API documentation Publish the API so it's publicly available

atkawa7 commented 5 years ago

@craigappl Checkout https://github.com/atkawa7/httpsnippet for generating code snippets with springfox and redoc