Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Provide a way to generate doc service using `Route` API

See original GitHub issue

Currently, DocService only supports annotated service for REST API to generate specification. Even though the restriction is described in the documentation, users often get confused when their REST API written by Route API doesn’t appear on the doc service.

If DocService generates a specification based on Route and AbstractHttpService, all user API can be seen in doc service. And in the long run, Kotlin Routing DSL API gets a benefit from it.

Issue Analytics

State:
Created 4 years ago
Comments:9 (7 by maintainers)

Top GitHub Comments

1reaction

heowccommented, Jun 24, 2021

I’ve tried this.

1reaction

heowccommented, Jul 12, 2020

I’m interested in this.😳

Top Results From Across the Web

How to Create Documentation for Your REST API with Insomnia

To create the documentation, you'll use Insomnia, a free and open-source ... An object containing the routes provided by the API, methods, ...

API Documentation Made Easy with OpenAPI & Swagger

How to generate OpenAPI from existing APIs ... Head over to Swagger Inspector, and insert the end point of the resource you want...

5 Tools for Documenting Your Web API - Prisma

Documentation generated using Swagger can create API test cases, automate API-dependent processes, and create an interactive environment to test ...

Create Beautiful API Documentation with these Tools - Geekflare

A properly structured and well-written documentation explaining how to use an API effectively and integrate it easily can help developers big time. The....

How to autogenerate API documentation from Express route ...

Make a new route that is used purely for outputting your doco to a file. In that route handler, parse though res.app._router.map.GET, res.app._router.map....