Generate API documentation (Swagger) from code

servinglynk / hslynk-open-source-docs

Contains wiki documentation, and issue tracker for the HSLynk Open Human Services Data Exchange Platform project. Code is in a different repo: https://github.com/servinglynk/hslynk-open-source . API docs are at https://docs.hslynk.com . General website is at:

http://www.hslynk.com/

Mozilla Public License 2.0

9 stars 3 forks source link

Generate API documentation (Swagger) from code #604

Open suryayadavalli opened 6 years ago

suryayadavalli commented 5 years ago

Not able to resolve the generation of Hyper media links from Swagger, due to limited support with current Swagger framework / Spring fox dependencies that extend support for Swagger. Looking at few other alternatives that might help generating HAL links. Will continue working on this issue.

eric-jahn commented 5 years ago

This article makes it seem like a newer version of Swagger/Spring Fox can handle HAL links: https://dzone.com/articles/is-that-documented-anywhere

I see the original problem from the Spring Fox maintainer in the solution: https://stackoverflow.com/questions/24389733/document-hal-links-from-spring-hateoas-with-swagger