Skip to main content

SDK Generators

Overview​

PGOS provides open API specification of backend HTTP API for developers to generate their own sdk client in different languages. In this document, you can learn how to generate sdk client for PGOS backend HTTP API.

1. Download open API specification of PGOS backend HTTP API​

You can download the openAPI specification of in PGOS backend HTTP API Reference page. This is an OpenAPI definition used by documentation generation tools to display the PGOS backend API. Also it can also be used by code generation tools to generate servers and clients in various programming languages, testing tools, and many other use cases.

image-20230630162400342

2. Generate SDK client​

There are bunch of tools to generate code for openAPI specification. You can select your favorite tools to generate SDK client by

swagger-codegen or other SDK Generators provided by community. Please check out the documentation of your selected tools for details.

3. Implement the backend HTTP API Specification​

You will also need to implement the backend HTTP API specification before making a successful request. Please check out the backend HTTP API specification for details.