samvera / questioning_authority

Question your authorities
Other
54 stars 30 forks source link

Add Swagger API documentation for linked data API #175

Closed elrayle closed 6 years ago

elrayle commented 6 years ago

Adds an installer to add swagger API docs for the linked data module. The doc is installed in public/apidoc directory of the app including QA.

To view what the apidoc installer will do: (from the app including QA >= 2.1.2)

rails g qa:apidoc -h

To run the apidoc installer: (from the app including QA >= 2.1.2)

rails g qa:apidoc

This will install the docs in your app at... public/qa/apidoc

To view the API documentation:

https://YOUR_APP_HOST/qa/apidoc/

NOTE: The trailing / is required.