Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/H21lab/5GC_build

Project to use OpenAPI generators to build code from 5GC_API
https://github.com/H21lab/5GC_build

3gpp 5g 5g-protocol 5gc openapi openapi-generators yaml-files

Last synced: 3 months ago
JSON representation

Project to use OpenAPI generators to build code from 5GC_API

Host: GitHub
URL: https://github.com/H21lab/5GC_build
Owner: H21lab
License: apache-2.0
Created: 2020-05-31T12:29:04.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-02-15T23:45:16.000Z (over 1 year ago)
Last Synced: 2024-04-07T06:33:00.385Z (7 months ago)
Topics: 3gpp, 5g, 5g-protocol, 5gc, openapi, openapi-generators, yaml-files
Language: Java
Homepage:
Size: 263 KB
Stars: 14
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

awesome-5g - 5GC build - Project to use OpenAPI generators to build code from 5GC_API. (Tools / Diameter)

README

# 5GC build
5GC Open API build

Project contains simple Maven project which is using openapi-generator-maven-plugin. By using this project it is possible to generate 5G code from [5GC_API yaml](https://github.com/jdegre/5GC_APIs) files.

### Clone source code
```bash
git clone --recurse-submodules https://github.com/H21lab/5GC_build.git
```

## License
Licensed under the Apache License, Version 2.0

## Build Instructions
Open `5GC_code_generator` in netbeans or in other editor.

Edit the pom.xml to control which yaml files should be used for code generator and define the type of OpenAPI generator to be used. Additionally specify the `modelPackage`, `apiPackage`, `invokerPackage`. This is useful if multiple yaml files are generated in the same time to separate the generated code by namespaces.

Build the project using IDE or run `mvn clean install` in `5GC_code_generator` folder.

The OpenAPI generators will generate the code in `./target/generated-sources`.

NOTE: The code is using the latest openapi-generator-maven-plugin in version 5.0.0-SNAPSHOT. If this is not downloaded automatically, download the source code and build it before in IDE or run `mvn clean install` to install the project.

## Examples

You can run simple generate python client and server in this project in the following way:
```
cd Examples
bash run_python_server.sh &
bash run_python_client.sh
```
By capturing on localhost http communication can be captured between the client and server.
Please note, that the sample python server code has been modified to fix the generator issue (reported here ).

## Limitations

There are several limitations in existing OpenAPI generators. You can experience that the generated code could not be generated or compiled after and need to be corrected manually. In such cases open github issue at .

## Attribution
Created by Martin Kacer