feat: Adding openapi example API
This commit is contained in:
24
app/README.md
Normal file
24
app/README.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# ETA API v2
|
||||
|
||||
This is the second generation of the ETA API developed on GoLang using OpenAPI to auto document and generate api endpoints.
|
||||
|
||||
# OpenApi Generator
|
||||
|
||||
With the following command the generator tool can be installed
|
||||
|
||||
```.{sh}
|
||||
go install github.com/deepmap/oapi-codegen/cmd/oapi-codegen@latest
|
||||
```
|
||||
|
||||
|
||||
|
||||
# Deployment
|
||||
|
||||
The details on how to deploy are described here
|
||||
|
||||
## DOTENV
|
||||
|
||||
```{.sh}
|
||||
SQL_DSN="{USER}:{PASS}@tcp({HOST}:{PORT})/{DB}?charset=utf8mb4&parseTime=true&loc=Local"
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user