This adds some types and extensions to Vapor's
Route type that allows documenting each route.
ViewContext object helps in bringing these documentations to a web page.
Finally, there's a default docs page to show all collected route documentation.
Add the following dependency to your
.package(url: "https://github.com/sersoft-gmbh/route-docs.git", from: "2.0.0"),
While not yet integrated, the following features might provide added value and could make it into RouteDocs in the future:
The API is documented using header doc. If you prefer to view the documentation as a webpage, there is an online version available for you.
If you find a bug / like to see a new feature in RouteDocs there are a few ways of helping out:
See LICENSE file.
|Last commit: 3 days ago|
Full Changelog: https://github.com/sersoft-gmbh/route-docs/compare/4.0.0...4.1.0