BugStalker API

BugStalker projects:

• bs-business backend
• bs-web-client frontend
• bs-api-specification API specification and generation tool

About The Project

The API specification project serves as the backbone for both frontend and backend development in the BugStalker application. It defines the API endpoints and data models, required for seamless communication between the frontend and backend applications.

In essence, the API Specification project not only documents the endpoints but also provides a mechanism to generate implementations of the specified endpoints, enhancing productivity and maintainability of the BugStalker application.

Built With

• Swagger + OpenAPI 3
• ng-openapi-gen

Getting Started

In order to generate web services and models you need to install ng-openapi-gen.

Prerequisites

• Java 17
• Maven
• Node.js
• npm
• ng-openapi-gen
• python*

Maven profiles

• api-template-bundler runs api-bundler.py before install phase. Bundler merges all yaml models from src/main/schemas and endpoints from src/main/schemas into single openapi.yaml file.
• backend-code-gen enables Java jar file generation.
• web-code-gen runs after install phase. It generates frontend models and endpoint implementations.

Installation

1. Clone the repo

   git clone https://github.com/Kaliszando/bs-api-specification.git

2. Set output directory for fronted project in package.json

   "gen-web": "ng-openapi-gen --output ../bs-web-client/src/app/api"

3. Build API project.

   mvn clean install

Contact

Adam Kalisz [email protected]

LinkedIn @adam-kalisz

Other links linktr.ee/kaliszando

(back to top)