Do you use Swagger/OpenAPI to document your APIs? If so, what is your preferred way to generate the docs?

• swag

  36 9,744 7.7 Go

  Automatically generate RESTful API documentation with Swagger 2.0 for Go.

  

If so, how do you go about generating the interface files? I recently discovered swaggo which generates OpenAPI docs from Go annotations. My Googlefoo then led me to swagger-jsdoc and openapi-comment-parser which do the same thing from JSdoc-like comments. Do you use them, do you use some other module, or do you use some other approach entirely?

• swagger-jsdoc

  8 1,637 2.8 JavaScript

  Generates swagger/openapi specification based on jsDoc comments and YAML files.

  

If so, how do you go about generating the interface files? I recently discovered swaggo which generates OpenAPI docs from Go annotations. My Googlefoo then led me to swagger-jsdoc and openapi-comment-parser which do the same thing from JSdoc-like comments. Do you use them, do you use some other module, or do you use some other approach entirely?

• SurveyJS

  surveyjs.io sponsored

  Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App. With SurveyJS form UI libraries, you can build and style forms in a fully-integrated drag & drop form builder, render them in your JS app, and store form submission data in any backend, inc. PHP, ASP.NET Core, and Node.js.

  

• openapi-comment-parser

  1 254 0.0 CSS

  ⚓️ JSDoc Comments for the OpenAPI Specification

  

If so, how do you go about generating the interface files? I recently discovered swaggo which generates OpenAPI docs from Go annotations. My Googlefoo then led me to swagger-jsdoc and openapi-comment-parser which do the same thing from JSdoc-like comments. Do you use them, do you use some other module, or do you use some other approach entirely?

• routing-controllers

  6 4,325 9.0 TypeScript

  Create structured, declarative and beautifully organized class-based controllers with heavy decorators usage in Express / Koa using TypeScript and Routing Controllers Framework.

  

I currently use https://github.com/typestack/routing-controllers and https://github.com/epiphone/routing-controllers-openapi with https://github.com/Redocly/redoc

• routing-controllers-openapi

  1 301 0.0 TypeScript

  Runtime OpenAPI v3 schema generation for routing-controllers.

I currently use https://github.com/typestack/routing-controllers and https://github.com/epiphone/routing-controllers-openapi with https://github.com/Redocly/redoc

• redoc

  35 22,462 7.5 TypeScript

  📘 OpenAPI/Swagger-generated API Reference Documentation

  

I currently use https://github.com/typestack/routing-controllers and https://github.com/epiphone/routing-controllers-openapi with https://github.com/Redocly/redoc

• apifire

  1 1 4.3 JavaScript

  Generates node.js express validators / routers / controllers in Typescript using an OpenAPI 3.0 spec

• InfluxDB

  www.influxdata.com sponsored

  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.

  

• hapi-swagger

  1 912 7.5 JavaScript

  A Swagger interface for hapi

  

For https://emailengine.app I generate swagger docs with the hapi-swagger plugin https://github.com/hapi-swagger/hapi-swagger - the process is pretty much fully automatic as it uses the input and output schema validations.

• emailengine

  30 1,771 9.5 JavaScript

  Headless email client

  

For https://emailengine.app I generate swagger docs with the hapi-swagger plugin https://github.com/hapi-swagger/hapi-swagger - the process is pretty much fully automatic as it uses the input and output schema validations.

• microprofile-open-api

  1 129 6.5 Java

  Microprofile open api

  

see: https://github.com/eclipse/microprofile-open-api/blob/master/spec/src/main/asciidoc/microprofile-openapi-spec.asciidoc

• foal

  16 1,855 8.8 TypeScript

  Full-featured Node.js framework, with no complexity. 🚀 Simple and easy to use, TypeScript-based and well-documented.

  

FoalTS allows you to generate your OpenAPI documentation directly from your code: https://foalts.org/docs/api-section/openapi-and-swagger-ui.

• openapi-typescript

  16 4,556 9.3 TypeScript

  Generate TypeScript types from OpenAPI 3 specs

Thank you! I'm using Stoplight and am very happy with it. I ended up using openapi-typescript to generate interfaces from the .yaml published from Stoplight, I might use openapi-typescript-codegen for client SDK later on.

Suggest a related project