Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.38 KB

README.md

File metadata and controls

38 lines (26 loc) · 1.38 KB
Raw

Overview

This repository implements the automatic generation of client libraries to access STACKIT APIs. It is based on the OpenAPI Generator. The process' input are the REST API specs in the OpenAPI Specification format (OAS), which are stored in STACKIT API specifications.

Currently only generation of Go libraries are supported. The output is stored in the STACKIT GO SDK repo.

Getting started

If you want to modify script or templates and you can run code locally.

Requires Go 1.20 or higher.

  1. Set up the project and tools by running 
    make project-tools
  2. Download Open Api Specifications (OAS), that are the input for the SDK generation, by running 
    make download-oas
    This step needs to be done only at the first start and when OAS updates are present.
  3. Run the SDK generation for testing by 
    make generate-sdk
    The output goes to the ./sdk folder.

Reporting issues

If you encounter any issues or have suggestions for improvements, please open an issue in the repository.

Contribute

Your contribution is welcome! For more details on how to contribute, refer to our Contribution Guide.

License

Apache 2.0