https://github.com/dsuurlant/response2schema
A quick and easy tool for generating OpenAPI schemas.
https://github.com/dsuurlant/response2schema
Last synced: about 2 months ago
JSON representation
A quick and easy tool for generating OpenAPI schemas.
- Host: GitHub
- URL: https://github.com/dsuurlant/response2schema
- Owner: dsuurlant
- License: mit
- Created: 2020-05-24T16:00:11.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-10-09T08:36:50.000Z (over 1 year ago)
- Last Synced: 2024-09-18T01:16:25.346Z (7 months ago)
- Language: PHP
- Size: 90.8 KB
- Stars: 84
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- jimsghstars - dsuurlant/response2schema - A quick and easy tool for generating OpenAPI schemas. (PHP)
README
# Response2Schema
A quick 'n easy way to generate your OpenAPI spec based on a JSON object. Useful for bootstrapping your component
schemas. This is intended to be a starting point for writing your specification, as the tool cannot infer types such
as enum, oneOf, maximum/minimum, and so on. It also does not support generating endpoints or error responses. All
it does is take your JSON object and turns it into an OpenAPI schema object, along with a simple example spec that
you can expand on.
Supports generating an OpenAPI spec in `JSON` or `yaml`.
# Installation
`composer require dsuurlant/response2schema`
Or download the phar from the [Releases page](https://github.com/dsuurlant/response2schema/releases).
# Usage
Just point Response2Schema to your input json file, and tell it where to put the output OpenAPI spec.
It will automatically format it to json or yaml based on the extension of the output path.
`./vendor/bin/response2schema response.json openapi.yaml`
Or when using the phar:
`./response2schema.phar response.json openapi.yaml`
# Example
Given a very simple response:
```json
{
"id": 1,
"name": "Example Response"
}
```
Response2Schema generates the following spec:
```yaml
openapi: 3.0.0
info:
title: 'OpenAPI specification automatically generated by Response2Schema.'
description: 'Please adapt this specification to your own needs.'
version: 1.0.0
paths:
/resource:
get:
description: 'Description of the endpoint'
operationId: getResource
responses:
'200':
description: 'Description of this response.'
content:
application/json:
schema:
$ref: '#/components/schemas/Resource'
components:
schemas:
Resource:
type: object
properties:
id:
type: integer
name:
type: string
```
It will always generate the example endpoint and a schema named 'Resource'.
The best way to use this tool is to take this as a starting point, or copy-paste the schema definition to your own
OpenAPI spec.
# Credits
Built and maintained by [Daniëlle Suurlant](https://github.com/dsuurlant).
Relies heavily on the awesome PHP OpenAPI library [cebe/php-openapi](https://github.com/cebe/php-openapi).