mirror of
https://github.com/nextcloud/openapi-extractor.git
synced 2025-12-24 03:08:19 +01:00
No description
|
|
||
|---|---|---|
| .github | ||
| bin | ||
| LICENSES | ||
| src | ||
| tests | ||
| .editorconfig | ||
| .gitignore | ||
| .php-cs-fixer.dist.php | ||
| AUTHORS.md | ||
| CHANGELOG.md | ||
| composer.json | ||
| composer.lock | ||
| generate-spec.php | ||
| LICENSE | ||
| merge-specs.php | ||
| README.md | ||
| rector.php | ||
| REUSE.toml | ||
openapi-extractor
Installation
composer require --dev nextcloud/openapi-extractor
To avoid dependency and PHP version conflicts it is best to install the package to vendor-bin using https://github.com/bamarni/composer-bin-plugin instead.
Create a CI workflow to check the specifications are up-to-date
The Workflow template repository has a template available: https://github.com/nextcloud/.github/blob/master/workflow-templates/openapi.yml
Afterward in your repository settings set the OpenAPI workflow to be required for merging pull requests.
Usage
Checkout the OpenAPI tutorial at https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-openapi.html to see how you can use openapi-extractor.
🐢 Performance
Make sure that you have xdebug turned off when generating OpenAPI specs, otherwise it can take multiple minutes instead of seconds.