Service Catalog API is a REST API written in Golang that can be used as a storage of a collection of services along with it's respective versions.

1. Gin web framework
2. PostgreSQL (database)
3. sqlx is used to interact with the database
4. zap for logging
5. viper to get the env variables
6. jwt for authentication
7. validator to validate incoming requests
8. goose to handler migrations
9. Docker and Kubernetes for easy deployment

There is a foreign key for user_uuid in the services table and another foreign key for service_id in the service_versions table.

Prerequisites: Install goose

• Create a config.yaml file and paste the content of the config.sample.yaml file (Change values as per usage)
• Create a postgres instance and run the migration file provided in the database directory. To make it easy, I have added command in the Makfile to do the same.

make db-up
make db-migrate

• Run the server

make run

• You can run the tests using the given command

make test

• If you want to build the application, you can use

make build

To view the OpenAPI documentation, you can run the following command in the terminal to start a swagger docker container

make spec-up

You can then view the documentation on http://localhost:8080/

To stop the swagger container, run

make spec-down

• Use of preseverd JWT token that does not expire
• Writing all the tables and references in a single file. Done considering it is a simple CRUD API
• Pass of a context in each function to allow easy integration of tracing if required
• Separating of database operations as much as possible to increase code readability
• Addition of similar databse operations for transactional queries as done for the database operations in this file for easier code readability
• Haven't written tests for all cases of the handlers

• Services can be updated but versions cannot be updated
• A version can only be created or deleted
• A single service cannot have multiple rows of the same version