Skip to content

Commit

Permalink
chore: including instructions about OpenAPI generation
Browse files Browse the repository at this point in the history
  • Loading branch information
andrea-deri committed Jan 29, 2025
1 parent f90a8eb commit edabfd8
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,12 @@ Manage FDR ( aka "Flussi di Rendicontazione" ) exchanged between PSP and EC

## Api Documentation 📖

- Internal API - See the [OpenApi 3 here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/pagopa/pagopa-fdr/main/openapi/openapi_internal.json)
- Organization API - See the [OpenApi 3 here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/pagopa/pagopa-fdr/main/openapi/openapi_organization.json)
- PSP API - See the [OpenApi 3 here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/pagopa/pagopa-fdr/main/openapi/openapi_psp.json)
- Internal API - See
the [OpenApi 3 here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/pagopa/pagopa-fdr/main/openapi/openapi_internal.json)
- Organization API - See
the [OpenApi 3 here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/pagopa/pagopa-fdr/main/openapi/openapi_organization.json)
- PSP API - See
the [OpenApi 3 here](https://editor.swagger.io/?url=https://raw.githubusercontent.com/pagopa/pagopa-fdr/main/openapi/openapi_psp.json)

In local env typing following url on browser for ui interface:

Expand Down Expand Up @@ -78,7 +81,9 @@ You can run your application in dev mode that enables live coding using:
```shell script
./mvnw compile quarkus:dev
```

Otherwise, with quarkus CLI:

```
brew install quarkusio/tap/quarkus
quarkus dev -DskipTests=true
Expand All @@ -97,6 +102,14 @@ sh build-and-run.sh build

for run use ```sh build-and-run.sh run```

## Creating updated OpenAPI Swaggers

You can create all updated OpenAPI Swaggers using:

```shell script
sh build-and-run.sh generate_openapi
```

---

# Run Tests 🧪 [WIP] 👩‍💻
Expand Down

0 comments on commit edabfd8

Please sign in to comment.