What do you think about generating OpenAPI specs from code?

• springfox

  7 5,906 0.0 Java

  Automated JSON API documentation for API's built with Spring

  

The only issue I saw on this is that controllers get a lot more cluttered. See an example.

• InfluxDB

  www.influxdata.com featured

  Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

  

• springdoc-openapi

  18 3,139 8.8 Java

  Library for OpenAPI 3 with spring-boot

  

I found SpringDoc, a library that automates the generation of the spec from the source code. It relies on annotations for textual bits (like tags and descriptions), but it also infers stuff from Spring annotations.

• raido

  3 7 9.7 Java

  Raido - Oceania region implementation of the RAiD ISO standard

  

• swagger-editor

  40 8,718 9.5 JavaScript

  Swagger Editor

  

FWIW, we go the other way, i.e., using the spec to generate code using openapi-generator. Generated code quality is high. We generate both model classes and service interfaces. In practice, this allows the team to discuss API design decisions at a high level on the fly in the spec editor, and then use the generated code to quickly divide and conquer implementation. We are also more microservice than monolith, though, so we tend to have more, smaller APIs, which probably factors into our experience.

• openapi-generator

  236 20,326 9.9 Java

  OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)

  

FWIW, we go the other way, i.e., using the spec to generate code using openapi-generator. Generated code quality is high. We generate both model classes and service interfaces. In practice, this allows the team to discuss API design decisions at a high level on the fly in the spec editor, and then use the generated code to quickly divide and conquer implementation. We are also more microservice than monolith, though, so we tend to have more, smaller APIs, which probably factors into our experience.

• openapi-typescript

  17 4,842 9.3 TypeScript

  Generate TypeScript types from OpenAPI 3 specs

I'm at a fairly small company (15devs max) and we do code first -> generate openapi spec with springdoc-openapi -> generate typescript httpclient with openapi-typescript for our frontend

Suggest a related project