Nextcloud-Archive/openapi-extractor
1
0
Fork 0
mirror of https://github.com/nextcloud/openapi-extractor.git synced 2025-10-26 15:06:52 +01:00
Code Issues Projects Releases Packages Wiki Activity
No description
598 commits 12 branches 21 tags 1.1 MiB
Find a file
Exact
Kate f2684605b0
 Merge pull request #277 from nextcloud/dependabot/composer/rector/rector-2.2.2
2025-10-11 07:29:08 +02:00
.github ci: Test even more apps 2025-05-13 12:19:34 +02:00
bin fix(bin): Call correct script in merge-specs 2025-03-17 07:59:19 +01:00
LICENSES ci: Add reuse action 2024-09-15 16:18:45 +02:00
src chore(php): Remove 8.2 deprecations 2025-10-06 09:36:18 +02:00
tests Merge pull request #274 from nextcloud/fix/openapitype/class-string-array-key 2025-10-01 15:53:28 +02:00
.editorconfig chore: Add SPDX header 2024-09-15 16:17:47 +02:00
.gitignore chore: Add SPDX header 2024-09-15 16:17:47 +02:00
.php-cs-fixer.dist.php refactor: Use separate bin files to allow adding .php extension to all files 2024-11-13 14:31:12 +01:00
AUTHORS.md chore: Add SPDX header 2024-09-15 16:17:47 +02:00
CHANGELOG.md chore: Add SPDX header 2024-09-15 16:17:47 +02:00
composer.json build(deps): bump phpstan/phpdoc-parser from 1.33.0 to 2.1.0 2025-02-22 03:13:01 +00:00
composer.lock build(deps-dev): bump rector/rector from 2.1.7 to 2.2.2 2025-10-11 01:03:22 +00:00
generate-spec.php fix(generate-spec): Include schemas only used in capabilities 2025-10-01 14:52:01 +02:00
LICENSE Initial commit 2022-11-04 18:04:21 +01:00
merge-specs.php refactor: Apply rector refactorings 2025-05-15 10:26:36 +02:00
README.md docs: Add reuse status badge 2024-09-15 16:23:35 +02:00
rector.php refactor: Improve the code quality 2024-11-13 14:31:12 +01:00
REUSE.toml chore: Add SPDX header 2024-09-15 16:17:47 +02:00

README.md

openapi-extractor

REUSE status

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.