Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nextcloud/openapi-extractor
A tool for extracting OpenAPI specifications from Nextcloud source code
https://github.com/nextcloud/openapi-extractor
nextcloud openapi php
Last synced: about 4 hours ago
JSON representation
A tool for extracting OpenAPI specifications from Nextcloud source code
- Host: GitHub
- URL: https://github.com/nextcloud/openapi-extractor
- Owner: nextcloud
- License: agpl-3.0
- Created: 2022-11-04T17:04:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-25T11:11:29.000Z (11 days ago)
- Last Synced: 2025-01-25T12:18:42.913Z (11 days ago)
- Topics: nextcloud, openapi, php
- Language: PHP
- Homepage: https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-openapi.html
- Size: 682 KB
- Stars: 7
- Watchers: 4
- Forks: 2
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Authors: AUTHORS.md
Awesome Lists containing this project
README
# openapi-extractor
[](https://api.reuse.software/info/github.com/nextcloud/openapi-extractor)
## Installation
```sh
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.