{"repo":"readmeio/swagger-inline","free":true,"listed":false,"github":"https://github.com/readmeio/swagger-inline","clone":"git clone https://github.com/readmeio/swagger-inline.git","description":"Generate an OpenAPI/Swagger definition from inline comments.","language":"JavaScript","stars":142,"topics":["swagger","openapi"],"license":"ISC","category":"api-integrations-sdks","readme_excerpt":"Warning This library is no longer being actively maintained (except for critical security fixes) nor is it recommended. We recommend using JSON Schema-based, strongly-typed tools to generate your OpenAPI definition (e.g., FastAPI, fastify-swagger ). swagger-inline Generate an OpenAPI/Swagger definition from inline comments. - Installation - Usage - CLI - Library - Examples Installation Usage CLI Example Options The inputGlobs argument is a list of files, or globs, to search for Swagger/OAS comments. - base : Base API specification to extend. Required - format : Output filetype: .json or .yaml (default: .json ) - scope : Matches the scope field defined in each API. For example, if --scope public is supplied, all operations will be generated, if --scope private , only those operations that have a scope: private declaration will be included. Library Example Available options - base : Base specification to extend. Required - format : Output filetype: .json or .yaml (default: .json ) - ignore : An array of globs for files to ignore. (default: ['node modules/ / ', 'bower modules/ / '] , - logger : Function called for logging. (default: empty closure) - metadata : Add additional annotations to the Swagger file, prefixed with x-si . - scope : Matches the scope field defined in each API. For example, if --scope public is supplied, all operations will be generated, if --scope private , only those operations that have a scope: private declaration will be included. - ignoreErrors : Ignor","default_branch":null,"files":null,"tree":[],"storefront":"/r/readmeio","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/readmeio/swagger-inline/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}