Developers to use APIs locally using Localstack

[melon-ruet]

Feature Request

As a developer Given I have dockerized dev environment And I can deploy the project to localstack And BloodConnect APIs with API Gateway is also deployed to localstack When I want to invoke use the API locally Then I must want to use it from localstack local deployment

Why is it important?

• Developers can use local environment for testing
• Save time to deploy and check in real server/cloud
• This is usable in future for integration testing

Proposed Solution:

• Make a combined openapi spces
• Fill up the placeholders of openapi specs with localstack resource information
• Use swagger UI (or alternative) to run it locally
• Use APIs from Swagger UI (or alternative)
• If Swagger UI is not viable option then Use Bruno

Describe alternatives you've considered:

• OpenAPI speces upload to a SAAS based solution.
• Use the APIs from there.

Acceptance Criteria

• [x] Make sure resources are properly deployed to localstack
• [ ] Handle localstack permissions if necessary
• [x] API Gateway in localstack must be accessible using a locally available endpoint
• [x] Add proper documentation how to use it
• [ ] Solution must be dockerized

Impact Analysis (optional)

No impact on any deployment

Documentation References (optional)

• Swagger UI
• Swagger UI Docker
• Redocly

[melon-ruet]

Bruno seems promising

[melon-ruet]

@mahinuzzaman Seems all the PRs are merged. Do you want to close/done this ticket?

[melon-ruet]

There are 2 updates

1. We have decided to use bruno for now.
2. There is a good progress with Swagger UI. But there are still some limitations like environment variables scripting in Swagger UI. Still WIP Swagger UI is merged and maybe we will try to use it in future.