Skip to content
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

Closed
benjamin-heasly opened this issue May 27, 2015 · 7 comments
Closed

Add HAL "Curies" for OpenHDS rels #17

benjamin-heasly opened this issue May 27, 2015 · 7 comments

Comments

@benjamin-heasly
Copy link
Owner

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.

@benjamin-heasly
Copy link
Owner Author

Maybe we just serve documentation from openhds-rest, along side the REST API!

@benjamin-heasly
Copy link
Owner Author

Does Spring give us an easy way to serve easy-to-author static content like markdown?

@benjamin-heasly
Copy link
Owner Author

Spring HATEOAS supports HAL curies via its CurieProvider API: http://docs.spring.io/spring-hateoas/docs/current/reference/html/#spis.curie-provider

@benjamin-heasly
Copy link
Owner Author

Let's say there are two parts to this:

  1. figure out how to author and serve static docs from openhds-rest, along side the REST API.
  2. add a HATEOAS CurieProvider to integrate HATEOAS links with the docs.

Let's give about 1 day for each of those.

This issue is separate actually authoring the documentation. See #118 .

@benjamin-heasly
Copy link
Owner Author

Example of serving markdown with Spring Boot.
https://github.com/jetaggart/spring-boot-markdown

@benjamin-heasly
Copy link
Owner Author

17633c9 adds markdown documentation and serves it from /documentation/foo

@benjamin-heasly
Copy link
Owner Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant