-
Notifications
You must be signed in to change notification settings - Fork 3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add HAL "Curies" for OpenHDS rels #17
Comments
Maybe we just serve documentation from openhds-rest, along side the REST API! |
Does Spring give us an easy way to serve easy-to-author static content like markdown? |
Spring HATEOAS supports HAL curies via its CurieProvider API: http://docs.spring.io/spring-hateoas/docs/current/reference/html/#spis.curie-provider |
Let's say there are two parts to this:
Let's give about 1 day for each of those. This issue is separate actually authoring the documentation. See #118 . |
Example of serving markdown with Spring Boot. |
17633c9 adds markdown documentation and serves it from |
See deployed example: https://arcane-lake-8447.herokuapp.com/documentation/registration-use-cases |
We should make our API "Discoverable" by using curies, as described here ("API Discoverability" near the bottom:
http://stateless.co/hal_specification.html
This would mean having a resource(s) that serves documentation. This would mean having documentation at all.
The text was updated successfully, but these errors were encountered: