Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iver-wharf/wharf-api
Wharf backend written in Go
https://github.com/iver-wharf/wharf-api
gin gin-gonic golang gorm swaggo wharf
Last synced: 5 days ago
JSON representation
Wharf backend written in Go
- Host: GitHub
- URL: https://github.com/iver-wharf/wharf-api
- Owner: iver-wharf
- License: mit
- Created: 2021-05-10T08:07:52.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-05-10T17:37:20.000Z (over 2 years ago)
- Last Synced: 2024-11-15T22:45:34.485Z (about 1 month ago)
- Topics: gin, gin-gonic, golang, gorm, swaggo, wharf
- Language: Go
- Homepage:
- Size: 700 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Wharf API
[](https://www.codacy.com/gh/iver-wharf/wharf-api/dashboard?utm_source=github.com\&utm_medium=referral\&utm_content=iver-wharf/wharf-api\&utm_campaign=Badge_Grade)
The API is one of the main components in Wharf. Its purpose is mainly a
[CRUD](https://en.wikipedia.org/wiki/Create,\_read,\_update_and_delete)
interface on top of the database that the other components in Wharf interact
with.
## Components
- HTTP API using the [gin-gonic/gin](https://github.com/gin-gonic/gin)
web framework.
- Swagger documentation generated using
[swaggo/swag](https://github.com/swaggo/swag) and hosted using
[swaggo/gin-swagger](https://github.com/swaggo/gin-swagger).
- Database [ORM](https://en.wikipedia.org/wiki/Object%E2%80%93relational_mapping)
using [gorm.io/gorm](https://gorm.io/).
## Configuring
The wharf-api program can be configured via environment variables and through
optional config files. See the docs on the `Config` type over at:
## Development
1. Install Go 1.18 or later:
2. Install dependencies using [GNU Make](https://www.gnu.org/software/make/) or
[GNUWin32](http://gnuwin32.sourceforge.net/install.html)
```console
$ make deps
```
3. Generate the Swagger files (this has to be redone each time the swaggo
documentation comments has been altered):
```console
$ make swag
```
4. Start hacking with your favorite tool. For example VS Code, GoLand,
Vim, Emacs, or whatnot.
## Releasing
Replace the "v2.0.0" in `make docker version=v2.0.0` with the new version. Full
documentation can be found at [Releasing a new version](https://iver-wharf.github.io/#/development/releasing-a-new-version).
Below are just how to create the Docker images using [GNU Make](https://www.gnu.org/software/make/)
or [GNUWin32](http://gnuwin32.sourceforge.net/install.html):
```console
$ make docker version=v2.0.0
STEP 1: FROM golang:1.18 AS build
STEP 2: WORKDIR /src
--> Using cache de3476fd68836750f453d9d4e7b592549fa924c14e68c9b80069881de8aacc9b
--> de3476fd688
STEP 3: ENV GO111MODULE=on
--> Using cache 4f47a95d0642dcaf5525ee1f19113f97911b1254889c5f2ce29eb6f034bd550b
--> 4f47a95d064
STEP 4: RUN go get -u github.com/swaggo/swag/cmd/[email protected]
...
Push the image by running:
docker push quay.io/iver-wharf/wharf-api:latest
docker push quay.io/iver-wharf/wharf-api:v2.0.0
```
## Linting
```sh
make deps # download linting dependencies
make lint
make lint-go # only lint Go code
make lint-md # only lint Markdown files
```
Some errors can be fixed automatically. Keep in mind that this updates the
files in place.
```sh
make lint-fix
make lint-fix-go # only lint and fix Go files
make lint-fix-md # only lint and fix Markdown files
```
---
Maintained by [Iver](https://www.iver.com/en).
Licensed under the [MIT license](./LICENSE).