An open API service indexing awesome lists of open source software.

https://github.com/sanriodev/aandm_backend_gin

server for aandm
https://github.com/sanriodev/aandm_backend_gin

Last synced: about 2 months ago
JSON representation

server for aandm

Awesome Lists containing this project

README

        




lightweight API.

| Go-Report | Reference |
| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| [![Go Report Card](https://goreportcard.com/badge/github.com/sanriodev/aandm_server)](https://goreportcard.com/report/github.com/sanriodev/aandm_server) | [![GoDoc](https://godoc.org/github.com/sanriodev/aandm_server?status.svg)](https://godoc.org/github.com/sanriodev/aandm_server) |

The classic `aandm-API` rewritten in go for simplicity and blazingly fast performance!

> [!WARNING]
> Still under construction 👷

### Api basepath

`/api/v1` on port `3000`

### to run locally

```zsh
$ go run main.go
```

### to build into executable

```zsh
go build
```

## OpenAPI Documentation

### generate Swagger Documentation

```zsh
swag init
```

### format swag comments

```zsh
swag fmt
```

#### Swagger Basepath

`/doc`