README
¶
oapi-sample
OpenAPI and sqlc sample project
Requirements
- Go 1.17
- oapi-codegen
- sqlc
- postgresql 13
Setup
cd .devcontainer
docker compose up -d
go install github.com/deepmap/oapi-codegen/cmd/oapi-codegen@v1.8.2
go install github.com/kyleconroy/sqlc/cmd/sqlc@latest
Build
go build cmd/server/main.go
Run
go run cmd/server/main.go
Generate
Updates docs/openapi.yaml or sql//**.sql. generate.
go generate
or
for docs/openapi.yaml
oapi-codegen --config=types.cfg.yaml docs/openapi.yaml
oapi-codegen --config=server.cfg.yaml docs/openapi.yaml
for sql//**.sql
sqlc generate -f sqlc.yaml
Documentation
¶
Index ¶
- func ConnectDB(conn *sql.DB) (*db.Queries, error)
- type ItemStore
- func (i *ItemStore) DeleteItem(w http.ResponseWriter, r *http.Request, itemId openapi.ItemId)
- func (i *ItemStore) GetItemById(w http.ResponseWriter, r *http.Request, itemId openapi.ItemId)
- func (i *ItemStore) GetItems(w http.ResponseWriter, r *http.Request, params openapi.GetItemsParams)
- func (i *ItemStore) PatchItem(w http.ResponseWriter, r *http.Request, itemId openapi.ItemId)
- func (i *ItemStore) PostItems(w http.ResponseWriter, r *http.Request)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type ItemStore ¶
type ItemStore struct {
// contains filtered or unexported fields
}
func (*ItemStore) DeleteItem ¶
func (*ItemStore) GetItemById ¶
func (*ItemStore) GetItems ¶
func (i *ItemStore) GetItems(w http.ResponseWriter, r *http.Request, params openapi.GetItemsParams)
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.