diff --git a/README.md b/README.md index 037087f..8661fe8 100644 --- a/README.md +++ b/README.md @@ -36,13 +36,13 @@ gradle bootRun In our project, we leverage the OpenAPI Generator to streamline our development process. Here’s how it works: -1. **API Specifications**: All API specifications are defined in the `api-swagger.yaml` file. This file contains the entire API structure and expected behaviors. +1. **API Specifications**: All API specifications are defined in the [openapi.yaml](src/main/resources/openapi.yaml) file. This file contains the entire API structure and expected behaviors. -2. **Automatic Code Generation**: We use the OpenAPI Generator plugin which automatically picks up specifications from the `api-swagger.yaml` file. The plugin generates all the necessary code scaffolding based on these specifications, eliminating the need for manually creating controllers. +2. **Automatic Code Generation**: We use the OpenAPI Generator plugin which automatically picks up specifications from the [openapi.yaml](src/main/resources/openapi.yaml) file. The plugin generates all the necessary code scaffolding based on these specifications, eliminating the need for manually creating controllers. 3. **Implementing Business Logic**: Developers are required to implement the service that interfaces with the generated delegate. This service layer is where the business logic is written, ensuring that it conforms to the API specifications defined in the YAML file. -4. **Consistency and Compliance**: By adopting this workflow, we ensure that our API always remains consistent with the OpenAPI specifications. It also adheres to the standards set by our internal use of the Stoplight Studio editor, which aids in maintaining high standards and compliance throughout the API lifecycle. +4. **Consistency and Compliance**: By adopting this workflow, we ensure that our API always remains consistent with the OpenAPI specifications. It also adheres to the standards set by our internal use of the [Stoplight Studio editor](https://upcintua.stoplight.io/studio/jaqpot?importFiles=true), which aids in maintaining high standards and compliance throughout the API lifecycle. Using this approach, we keep our API definitions centralized, up-to-date, and aligned with the overall architectural requirements.