1mehdifaraji / swagger Goto Github PK

The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to HTTP APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network traffic inspection. When properly defined, a consumer can understand and interact with the remote service with a minimal amount of implementation logic.

An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.

This boilerplate is a demonstration of generating a single openapi.yaml file from many files used as components .

You can preview the build file in Swagger online editor website .

@1mehdifaraji