{"repo":"wapmorgan/OpenApiGenerator","free":true,"listed":false,"github":"https://github.com/wapmorgan/OpenApiGenerator","clone":"git clone https://github.com/wapmorgan/OpenApiGenerator.git","description":"OpenApi configuration generator directly from PHP code (PhpDoc and php type hints). Can be used with a large monolithic backend","language":"PHP","stars":21,"topics":["openapi","scraper","swagger","api","api-docs-generator","api-documentation"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"What is it? It is OpenApi configuration generator that works with origin source code + phpdoc. Main purpose of this library is to automatize generation of OpenApi-specification for existing JSON-API with a lot of methods. Idea by @maxonrock. 1. Open Api generator - Laravel Example - How it works - How to use - Integrations 2. Extending - New scraper - Settings - Limitations - ToDo OpenApiGenerator What it does? It generates OpenApi 3.0 specification files for your REST JSON-based API written in PHP from source code directly. You do not need to write OpenApi-specification manually. Laravel Example 1. Routes: 2. One controller: 3. One request and two responses: 4. Result of generation from code : two endpoints with description and arguments for select . How it works 1. Scraper collects info about API (tags, security schemes and servers, all endpoints) and contains settings for Generator. Scraper is framework-dependent. 2. Generator fulfills openapi-specification with endpoints information by analyzing source code: - summary and description of actions - parameters and result of actions Generator is common. It just receives information from Scraper and analyzes code by Scraper rules. More detailed process description is in How it works document. How to use Invoke console script to generate openapi for your project (with help of integrations): For example, for yii2-project: 1. Run parser on project to analyze files and retrieve info about endpoints 2. Generate specification(s) int","default_branch":null,"files":null,"tree":[],"storefront":"/r/wapmorgan","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/wapmorgan/OpenApiGenerator/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."}