OpenAPI Specification (OAS) support

New Feature / Enhancement Checklist

• I am not disclosing a vulnerability.
• I am not just asking a question.
• I have searched through existing issues.

Current Limitation

There is no support for the OpenAPI Specification (OAS) standard.

Feature / Enhancement Description

1. Serialization of Parse Server instances into OpenAPI documents

• Many major services including Github, Twitter etc. publish API details in OAS 3.1 format.
• "An OpenAPI definition can then be used by documentation generation tools to display the API, code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases."
• OpenAPI supports specification of full range of REST API functionality including multiple servers/endpoints/methods/headers/parameters, request/response formats, authorization/authentication details, callbacks/webhooks etc.

2. Code generation feature for deserializing OpenAPI definitions into fully functional Parse Server instances.

• Would enable a Infrastructure as Code (IaC) workflow (e.g. Docker Compose, Ansible, Terraform, ...) where the developer only needs to write out a REST API as a declarative configuration file, and Parse Server automatically handles the implementation of the interface.

Example Use Case

Detailed in above section.

Alternatives / Workarounds

Unaware of any other than manually transcribing OAS documents into Parse Server configuration.

3rd Party References

• https://github.com/openapitools/openapi-generator/
  • Generates clients and server stubs in multiple languages/frameworks
• https://openapi.tools/#server
  • List of server generators. Only one supports OAS 3.1 so far.
• https://github.com/nestjs/swagger
  • nest.js has a serialization module for an outdated version of OAS.

Remarks

• I would be willing to make contributions on this feature if there is any interest.
• I'm not completely familiar with this amazing project yet, so if I'm somehow way off mark with this, please don't hesitate to point it out.

No implementation files or tests are named. Start by reviewing the Parse Server REST API surface and the linked openapi-generator and openapi.tools references; the scope would need to define how serialization and code generation should work. Done would mean agreed support for producing OpenAPI 3.1 documents and turning definitions into functional Parse Server instances.