Tools

Use existing tools

Request send:

• CURL - https://curl.se
• Postman - https://www.postman.com
• IntelliJ IDEA (Tools -> Http Client) - https://www.jetbrains.com/idea/

For simple use-cases you can use CURL, but it’s heavily recommended using some more advanced tooling to communicate with Gooddata.CN API - especially with capability of generate API requests and payloads from - OpenAPI schema.

Postman

• Install Postman (how-to)
• hit Import, select link and put URL of raw OpenAPI schema

  

• hit Continue, keep default advanced settings (be sure that Folder organization is set to Tags), hit Import

  

• select collections, open details and in Authorization tab select type Bearer Token + fill Token value with API Token

  

• open details and in Variables¹ tab and set baseUrl with base path (scheme + authority pointing to Gooddata.CN endpoint).

  

• pick one of the endpoints and try to send request

Generate your own client

1. get OpenAPI schema
2. generate client in language of your choice by https://openapi-generator.tech ²

example

generate TypeScript client to the current folder:

openapi-generator generate -i $ENDPOINT/docs/api/gooddata-cn-oapi-all-raw-schema.json -g typescript-rxjs -o .

where $ENDPOINT = OpenAPI schema