Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/apivideo/api.video-api-client-generator
Tool used to generate api.video's API clients, based on OpenAPI codegen
https://github.com/apivideo/api.video-api-client-generator
client java maven mustache-templates
Last synced: 3 months ago
JSON representation
Tool used to generate api.video's API clients, based on OpenAPI codegen
- Host: GitHub
- URL: https://github.com/apivideo/api.video-api-client-generator
- Owner: apivideo
- License: mit
- Created: 2021-03-09T13:45:08.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-31T21:35:42.000Z (3 months ago)
- Last Synced: 2024-10-31T22:25:42.675Z (3 months ago)
- Topics: client, java, maven, mustache-templates
- Language: Mustache
- Homepage: https://api.video
- Size: 61.6 MB
- Stars: 24
- Watchers: 2
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://twitter.com/intent/follow?screen_name=api_video) [](https://github.com/apivideo/api.video-api-client-generator) [](https://community.api.video)
api.video API client generator
[api.video](https://api.video/) is the video infrastructure for product builders. Lightning fast video APIs for integrating, scaling, and managing on-demand & low latency live streaming features in your app.
# Table of contents
- [Table of contents](#table-of-contents)
- [Project description](#project-description)
- [Getting started](#getting-started)
- [Requirements](#requirements)
- [Usage](#usage)
- [Documentation](#documentation)
- [Supported languages](#supported-languages)
- [Template files](#template-files)
- [Configuration files](#configuration-files)
- [Generator sub-class](#generator-sub-class)
- [Development](#development)
- [Configuration](#configuration)
- [CLI](#cli)
- [File](#file)
# Project description
API client generation tool based on [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator). Generates client source code in several languages based on [mustache templates](https://mustache.github.io/).
# Getting started
## Requirements
- Java 1.8+
- Maven
## Usage
To generate an API client:
```sh
mvn package -P [profile]
```
To see the list of available profiles, see the "profile" column in the table of [supported languages](#supported-languages).
# Documentation
## Supported languages
| Language | Profile | CI tests | CI package release | Repository |
|-------------------|------------------|--------------------|--------------------|----------------------------------------------------------------------------------|
| Java | java | :white_check_mark: | :white_check_mark: | [java-api-client](https://github.com/apivideo/api.video-java-client) |
| Android | android | :white_check_mark: | :white_check_mark: | [android-api-client](https://github.com/apivideo/api.video-android-client) |
| Android | android-uploader | :white_check_mark: | :white_check_mark: | [android-video-uploader](https://github.com/apivideo/api.video-android-uploader) |
| NodeJs/Typescript | nodejs | :white_check_mark: | :white_check_mark: | [nodejs-api-client](https://github.com/apivideo/api.video-nodejs-client) |
| Php | php | :white_check_mark: | - | [php-api-client](https://github.com/apivideo/api.video-php-client) |
| C# | csharp | :white_check_mark: | :white_check_mark: | [csharp-api-client](https://github.com/apivideo/api.video-csharp-client) |
| Go | go | :white_check_mark: | - | [go-api-client](https://github.com/apivideo/api.video-go-client) |
| Python | python | :white_check_mark: | :white_check_mark: | [python-api-client](https://github.com/apivideo/api.video-python-client) |
| Swift5 | swift5 | :white_check_mark: | :white_check_mark: | [ios-api-client](https://github.com/apivideo/api.video-ios-client) |
| Swift5 | swift5-uploader | :white_check_mark: | :white_check_mark: | [ios-video-uploader](https://github.com/apivideo/api.video-ios-uploader) |
## Template files
Mustache template files can be found in `templates/[profile]`.
Templates are based on default OpenAPI Generator [templates](https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator/src/main/resources).
## Configuration files
Each target language has it's own configuration file located at `config/[profile].yaml`.
```yml
apiPackage: video.api.client.api.clients # API files output folder
modelPackage: folder.subfolder.subsubfolder # model output folder
files:
page.mustache:
folder: src/main/java/video/api/client/api/models
destinationFilename: Page.java
ApiVideoAuthInterceptor.mustache:
folder: src/main/java/video/api/client/api/auth
destinationFilename: ApiVideoAuthInterceptor.java
EmptyArrayFixTypeAdapterFactory.mustache:
folder: src/main/java/video/api/client/api
destinationFilename: EmptyArrayFixTypeAdapterFactory.java
UploadChunkRequestBody.mustache:
folder: src/main/java/video/api/client/api/upload
destinationFilename: UploadChunkRequestBody.java
UploadProgressListener.mustache:
folder: src/main/java/video/api/client/api/upload
destinationFilename: UploadProgressListener.java
ApiVideoClient.mustache:
folder: src/main/java/video/api/client
destinationFilename: ApiVideoClient.java
pagination.md.mustache:
folder: docs
destinationFilename: Pagination.md
post-generate.sh:
destinationFilename: post-generate.sh
```
> - https://openapi-generator.tech/docs/globals/
> - https://openapi-generator.tech/docs/configuration/
> - https://openapi-generator.tech/docs/customization#user-defined-templates
> - https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java#L106-L111
## Generator sub-class
Some target language require tweaks that can't be done through the config file or the templates. In this case, a subclass of the generator is created at `apivideo-generator/src/main/java/video/api/client/generator/[pascal-case-profile].java`.
## Development
We recommend the usage of a dedicated [Java IDE](https://en.wikipedia.org/wiki/Comparison_of_integrated_development_environments#Java) to work on the development of this project.
Especially if you want to tweak one of the language specific `Codegen` written in `Java` you'll need to navigate through the class hierarchy.
### Configuration
A `CodegenConfigurator` instance is built from configurations coming from:
- the `CLI`
- a `yml` configuration file.
This `CodegenConfigurator` is then turned into a `ClientOptInput` (via the `toClientOptInput` method) to be fed to a `Generator`.
> __This is when our custom codegen, which implements `CodegenConfig` interface is involved.__
The generation is actually done by the `generate` method of the `DefaultGenerator` class.
This method will mainly :
- `processUserDefinedTemplates`
- `generateModels` given the list of `files` and available `models`
- `generateApis` given the list of `files` and available `operations`
- `generateSupportingFiles` given available `models` and `operations`
#### CLI
The profile configuration is first read from `pom.xml`, see java for example :
```xml
java
java
video.api.client.generator.Java
./post-generate.sh
```
When generating a client with the following command:
```
mvn package -P [profile]
```
Internally the `generate` command of the `openapi-generator-cli` run with the following options:
```xml
oas_apivideo.yaml
${generatorName}
${project.basedir}/templates/${folder}
${project.basedir}/config/${folder}.yaml
generated-clients/${folder}
```
#### File
The `yml` config file -- is loaded in the `CodegenConfigurator` class via the `fromFile` method.
> A class which manages the contextual configuration for code generation.
> This includes configuring the generator, templating, and the workflow which orchestrates these.
>
> This helper also enables the deserialization of `GeneratorSettings` via application-specific Jackson JSON usage (see `DynamicSettings`.
Each entry under the `files` key of the `yml` configuration file is used to build a `TemplateDefinition` object.
If not specified otherwise the file is treated as a `SupportingFile`.