finagle / finagle/finch

Swagger documentation auto-generation support

Open
#73 14 comments 13 reactions 0 assignees View on GitHub
feature question
Dominant language
Scala
Stars
1.6k
Forks
217
PR merge metrics
No merged PRs in 30d

Description

Swagger is a RESTful API Documentation Specification, most popular one for the moment:
https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md
It is like WSDL and WADL but a lot less horrible to work with. It comes with swagger-ui which is pure HTML+JS app to interactively explore a Swagger-enabled REST API. It can be easily integrated into your website and serve as a documentation for developers. Sample:
http://petstore.swagger.wordnik.com/

A Swagger doc can be written manually but it's better to have it auto-generated. We're all for self-documenting API's, don't we?
Please, consider to add support for it in finch.

At least, I beg to let the routing be programmatically inspectable so support for it can be implemented by a 3d party. It is what is missing in Spray.io and seems like the issue can never be addressed in a sane way because of the way it's routing is implemented:
https://groups.google.com/forum/#!searchin/spray-user/swagger/spray-user/P_6kNIfT7FQ/YNLq0AZmwx8J

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.