README.md

ShapeDiver API Specifications

This repository hosts OpenAPI Specification (OAS) files that describe various ShapeDiver APIs. These OAS files provide standardized and language-agnostic descriptions of HTTP APIs, facilitating developers to dynamically generate Client SDKs for multiple programming languages using tools like the OpenAPI Generator. This enables rapid development and integration of ShapeDiver APIs into your applications and reduces manual effort to update and maintain previously generated code while minimizing errors.

Supported ShapeDiver Systems

• Geometry Backend: OAS file is geometry_api_v2.yaml.

• Platform Backend: Coming soon!

Getting Started

To generate a Client SDK using the OpenAPI Generator, follow these steps:

1. Install OpenAPI Generator:
   Follow the installation instructions on the OpenAPI Generator homepage.
   Note: We recommend using NPM to install the generator for simple versioning.

   npm install @openapitools/openapi-generator-cli -g

2. Fetch the respective OAS file:
   Download the respective ShapeDiver OAS file and store it in your project's directory.

3. Generate the SDK:
   Use the OpenAPI Generator to generate the desired Client SDK:

   openapi-generator-cli generate \
       -i path/to/downloaded/openapi.yaml \
       -g <language> \
       -o path/to/output

   Replace <language> with the programming language of your choice (e.g., javascript, python). A full list of available languages is available here. Please note that for some languages the generator command must be provided additional options for best results. A list of available options can be found in the documentation of the generator in the respective language.

Available Client SDKs

• Geometry Backend:

  • TypeScript
  • Python
  • PHP

• Platform Backend:

  • TypeScript: Coming soon!

Support

If you have questions, please use the ShapeDiver Help Center.

You can find out more about ShapeDiver right here.

Licensing

This project is released under the MIT License.