Surnet / Swagger Jsdoc
Licence: mit
Generates swagger/openapi specification based on jsDoc comments and YAML files.
Stars: ✭ 1,057
Programming Languages
javascript
184084 projects - #8 most used programming language
Projects that are alternatives of or similar to Swagger Jsdoc
Openapi Comment Parser
⚓️ JSDoc Comments for the OpenAPI Specification
Stars: ✭ 221 (-79.09%)
Mutual labels: swagger, openapi, jsdoc
Express Jsdoc Swagger
Swagger OpenAPI 3.x generator
Stars: ✭ 69 (-93.47%)
Mutual labels: swagger, openapi, jsdoc
Swagger Core
Examples and server integrations for generating the Swagger API Specification, which enables easy access to your REST API
Stars: ✭ 6,898 (+552.6%)
Mutual labels: swagger, openapi
Swagger Editor Electron
Run standalone Swagger Editor in Electron shell
Stars: ✭ 10 (-99.05%)
Mutual labels: swagger, openapi
Molten Boilerplate
A boilerplate for the molten framework by Bogdanp https://github.com/Bogdanp/molten
Stars: ✭ 50 (-95.27%)
Mutual labels: swagger, openapi
Apispec
A pluggable API specification generator. Currently supports the OpenAPI Specification (f.k.a. the Swagger specification)..
Stars: ✭ 831 (-21.38%)
Mutual labels: swagger, openapi
Openapi Gui
GUI / visual editor for creating and editing OpenAPI / Swagger definitions
Stars: ✭ 891 (-15.7%)
Mutual labels: swagger, openapi
Oaichecker
Test your OpenAPI specs and your server API at the same time
Stars: ✭ 12 (-98.86%)
Mutual labels: swagger, openapi
Optic
Optic documents and tests your API as you build it
Stars: ✭ 760 (-28.1%)
Mutual labels: swagger, openapi
Swagger2
Loading, parsing and validating requests to HTTP services based on Swagger v2.0 documents
Stars: ✭ 20 (-98.11%)
Mutual labels: swagger, openapi
Oval
oval: CLI for (O)penAPI Specification document (val)idation.
Stars: ✭ 15 (-98.58%)
Mutual labels: swagger, openapi
Fastapi
FastAPI framework, high performance, easy to learn, fast to code, ready for production
Stars: ✭ 39,588 (+3645.32%)
Mutual labels: swagger, openapi
Oapi Codegen
Generate Go client and server boilerplate from OpenAPI 3 specifications
Stars: ✭ 806 (-23.75%)
Mutual labels: swagger, openapi
Schemathesis
A modern API testing tool for web applications built with Open API and GraphQL specifications.
Stars: ✭ 768 (-27.34%)
Mutual labels: swagger, openapi
Django Ninja
💨 Fast, Async-ready, Openapi, type hints based framework for building APIs
Stars: ✭ 875 (-17.22%)
Mutual labels: swagger, openapi
Kin Openapi
OpenAPI 3.0 implementation for Go (parsing, converting, validation, and more)
Stars: ✭ 776 (-26.58%)
Mutual labels: swagger, openapi
Widdershins
OpenAPI / Swagger, AsyncAPI & Semoasa definitions to (re)Slate compatible markdown
Stars: ✭ 856 (-19.02%)
Mutual labels: swagger, openapi
Paw Swaggerimporter
Swagger/OpenAPI 2.0 Importer for Paw
Stars: ✭ 34 (-96.78%)
Mutual labels: swagger, openapi
Swagger Parser
Swagger 2.0 and OpenAPI 3.0 parser/validator
Stars: ✭ 710 (-32.83%)
Mutual labels: swagger, openapi
swagger-jsdoc
This library reads your JSDoc-annotated source code and generates an OpenAPI (Swagger) specification.
Getting started
Imagine having API files like these:
/**
* @openapi
* /:
* get:
* description: Welcome to swagger-jsdoc!
* responses:
* 200:
* description: Returns a mysterious string.
*/
app.get('/', (req, res) => {
res.send('Hello World!');
});
The library will take the contents of @openapi
(or @swagger
) with the following configuration:
const swaggerJsdoc = require('swagger-jsdoc');
const options = {
definition: {
openapi: '3.0.0',
info: {
title: 'Hello World',
version: '1.0.0',
},
},
apis: ['./src/routes*.js'], // files containing annotations as above
};
const openapiSpecification = swaggerJsdoc(options);
The resulting openapiSpecification
will be a swagger tools-compatible (and validated) specification.
System requirements
- Node.js 12.x or higher
You are viewing swagger-jsdoc
v6 which is published in CommonJS module system.
Installation
npm install swagger-jsdoc --save
Or
yarn add swagger-jsdoc
Supported specifications
- OpenAPI 3.x
- Swagger 2
Documentation
Click on the version you are using for further details:
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].