openapi-extractor

KO | EN

gitlite — search

#react #ai #typescript #llm #deep-learning #linux #java #awesome #cli #kubernetes #awesome-list #security #pytorch #openai

openapi-extractor

(★ 11)

A tool for extracting OpenAPI specifications from Nextcloud source code

openapi-extractor Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# openapi-extractor

[![REUSE status](https://api.reuse.software/badge/github.com/nextcloud/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.

openapi-extractor

openapi-extractor Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

openapi-extractor

openapi-extractor Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README