CoderVlogger

Daily Update for Feb 21, 2022 #DevLog

Kanan Rahimov -

What did you do yesterday?

  • Started documenting API specifications for the Go Web Framework project. Having a documented API contract will help me to keep all separate implementations aligned.
  • Started working on the video documentation for the Fiber go web framework.
  • Setup and did initial configuration for my upcoming Teachable account.

What will you do today?

  • Finalize the API Documentation and publish it on the Go Web Frameworks repository.
  • Start working on project structure. I want to align the layout I use for each framework with Go-lang Standard Project Layout. I already did some preparation work with the Echo framework. But it is far away from the final version.

Additional Notable Resources

🔐 Members Only Addition

The following part shows the video recording with all related resources and source code snippets.

Example API Spec in Markdown

Soon to be published as part of CoderVlogger/go-web-frameworks repository.

# API Specs

This document explains API specification for `/entities` JSON API. This API is implemented in all mentioned Go Web Frameworks. Hence, the specification is required to keep them aligned and follow the same API contract.

## Endpoints

### `GET /entities`

List entities.

### Named Params

None.

#### Query Params

- `page` - page number

#### Status Codes

- `404` - if the given page number does not exist

### `GET /entities/1`

Get a single entity by entity's ID.

### Named Params

- `id` - id of a requested entity

#### Query Params

None.

#### Status Codes

- `404` - if an entity with the specified entity id does not exist
- `500` - if an error occurred during the storage operation

References