[#446][Part3] Add OpenAPI to support creating API documentation with OpenAPI

[sanG-github]

close #446

What happened 👀

• Added Dockerfile.mock
• Added fly.toml
• Added deploy_mock_server.yml

Insight 📝

Support mock_server add-on for the templates. This will help developers to deploy a mock server based on OpenAPI spec.

Here is the checklist of #446 when this pull request is merged:

• Add OpenAPI addon as an mandatory addon in the template.
• Add OpenAPI tooling (Spectral, Lint).
• Create an endpoint (e.g., GET {{base_url}}/api/docs/openapi) to access the API documentation through the browser.
• Add Mock Server with Prims (related to this API Mock Server with OpenAPI).
• Add CI/CD workflow to run linting and deploy mock server to fly.io:
  • Linting
  • Deploy Mock Server

Proof Of Work 📹

Deployed successfully on local.

[hoangmirs]

As this PR belongs to the OpenAPI addon, should we move all template files into that folder instead? And find a way to integrate it with other add-ons (Docker, GitHub)?

[malparty]

After discussion with Sang, OpenAPI might NOT be an add-on, but a "mandatory" part of the template, included in any of the variants (API & Web). I'll wait until later this week to confirm that with Su V. If it's the case, I would argue that it will help keep the template code simpler and easier to test :D

[olivierobert]

@malparty @sanG-github It cannot be a compulsory add-on if no API is built. You can refer to the Gin templates:

https://github.com/nimblehq/gin-templates/blob/ad4b942bf841d834665d7198ecbba810eebfcd86/hooks/pre_gen_project.py#L36-L40

[malparty]

All right, then let's implement it so that it does not leak in a new project that does not select the add-on 🙇

[suho]

For a mock server, it should be an add-on (you can check gin-templates)

• For API variant, we should show a message to ask if the developer want to have a mock server
• For Web variant, if the developer add openapi add on, then we will ask to have a mock server

[malparty]

@sanG-github last rebase needed :harold: