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.

Automated HTTP API documentation

See original GitHub issue

OpenAPI: we should try https://github.com/springfox/springfox/issues/1773 which has been merged and see if functional support is ok.

Spring REST docs: we should test WebTestClient support, see https://github.com/spring-projects/spring-restdocs/issues/384.

Issue Analytics

State:
Created 5 years ago
Comments:13 (4 by maintainers)

Top GitHub Comments

1reaction

sdeleuzecommented, Oct 28, 2020

We have been collaborating with @poutsma and the project lead of Springdoc to implement functional support of OpenAPI, and it is done, see https://github.com/springdoc/springdoc-openapi/issues/891. Let’s try to integrate that in Spring Fu for 0.5.0.

1reaction

sdeleuzecommented, Sep 19, 2018

Since I am a big fan of Spring REST docs but also recognize the need to document REST API in a machine readable way, I think I will prototype something based on @tgirard12 RouterFunctions.Visitor approach used with https://github.com/ePages-de/restdocs-openapi mentioned in https://github.com/spring-projects/spring-restdocs/issues/213.

Top Results From Across the Web

Automating API Documentation - Medium

Automating API Documentation. This article explains how we document our REST APIs in Condor Labs, in a maintainable and testable way, ...

Automatic API & REST API Documentation - Stoplight

Autogenerate your API documentation easily and within a matter of minutes using our Stoplight Docs software and instantly publish to the web.

Swagger: API Documentation & Design Tools for Teams

Simplify API development for users, teams, and enterprises with our open source and professional toolset. Find out how Swagger can help you and...

10 Best API Documentation Tools for 2022 [+Why Use One]

apiDoc is an open-source REST API documentation tool that automatically creates documentation from API descriptions in your source code. It can ...

5 Best API Documentation Tools - DreamFactory Software- Blog

5 Best API Documentation Tools · Swagger UI · SwaggerHub · ReDoc · DapperDox · OpenAPI Generator · Generate a full-featured,documented, and secure ......