{"id":21338385,"url":"https://github.com/rockymontana/oadocumentor","last_synced_at":"2025-03-16T02:15:49.556Z","repository":{"id":62536762,"uuid":"209539069","full_name":"rockymontana/OADocumentor","owner":"rockymontana","description":"Generates and validates OpenAPI documentation","archived":false,"fork":false,"pushed_at":"2019-09-23T13:08:39.000Z","size":12,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-01-22T15:09:08.969Z","etag":null,"topics":["laravel","laravel-pac","openapi","openapi-codegen"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rockymontana.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-19T11:43:24.000Z","updated_at":"2020-05-28T14:27:59.000Z","dependencies_parsed_at":"2022-11-02T15:16:00.487Z","dependency_job_id":null,"html_url":"https://github.com/rockymontana/OADocumentor","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rockymontana%2FOADocumentor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rockymontana%2FOADocumentor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rockymontana%2FOADocumentor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rockymontana%2FOADocumentor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rockymontana","download_url":"https://codeload.github.com/rockymontana/OADocumentor/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243814901,"owners_count":20352038,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["laravel","laravel-pac","openapi","openapi-codegen"],"created_at":"2024-11-22T00:14:54.703Z","updated_at":"2025-03-16T02:15:49.535Z","avatar_url":"https://github.com/rockymontana.png","language":"PHP","readme":"# OpenApi Documentation Generator\nGenerates and validate your OpenAPI documentation.\nBuild up your your open api documentation in a way that you're familiar with, PHP Arrays.\nInstead of making a static documentation for all your modules that is always shown, you can use this generator to only generate the docs based on the modules you have installed at the moment.\n\nWhen installing a new module you can generate the documentation again to inject that modules documentation to the bigger thing.\n\n\nAlso - it ships with [Redoc](https://redocly.github.io/redoc/) ([Github](https://github.com/Redocly/redoc)) so your clients can have a beatiful UI to look at when integrating to your API.\n\n## Installation\n\nYou can soon install the package via composer:\n\n```bash\ncomposer require rockymontana/oa-documentor\n```\n\n## Usage\n\n``` bash\nphp artisan openapi:generate\n```\n\n### Playground\nIf you want to try it out you can copy the docs-folder in `tests` into your project folder root and then run the generate command.\n\nThen you can fiddle with the documentation and add new path files and components as you wish. When you're done, re-generate the docs and watch it in the browser.\n\n### Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.\n\n## Contributing\n\nPlease see [CONTRIBUTING](CONTRIBUTING.md) for details.\n\n### Security\n\nIf you discover any security related issues, please email jonas@webbish.se instead of using the issue tracker.\n\n## Credits\n\n- [Jonas Erlandsson](https://github.com/rockymontana)\n- [All Contributors](../../contributors)\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frockymontana%2Foadocumentor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frockymontana%2Foadocumentor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frockymontana%2Foadocumentor/lists"}