SDK documentation overview
As part of SDK generation, liblab can generate SDK documentation for all the supported languages you have configured, as well as API documentation. This SDK documentation is available as a static site, and can be downloaded to be self hosted, or can be hosted by liblab.
SDK documentation uses the descriptions and examples from your API spec. The better the quality of your API spec, the better the quality of the SDK documentation.
Supported SDK languages
SDK documentation generation is available for the following SDK languages and liblab versions:
| SDK language | liblabVersion | SDK documentation supported |
|---|---|---|
| TypeScript | 1 | ✅ |
| Java | 1 | ✅ |
| Python | 1 | ✅ |
| Python | 2 | ❌ |
| C# | 2 | ❌ |
| Go | 2 | ❌ |
| Terraform | 2 | ❌ |
Features
The SDK documentation includes the following features:
- Code snippets for all SDK languages you have created, as well as using
curlto call the API directly - Documentation and examples taken from your API specification
- Support for markdown
- liblab hosted documentation, or you can download it and host it yourself