Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aerogo/api
:triangular_ruler: Automatically implements your REST API.
https://github.com/aerogo/api
api-server go rest-api
Last synced: 5 days ago
JSON representation
:triangular_ruler: Automatically implements your REST API.
- Host: GitHub
- URL: https://github.com/aerogo/api
- Owner: aerogo
- License: gpl-3.0
- Created: 2017-06-09T20:59:31.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-10-26T06:39:55.000Z (about 5 years ago)
- Last Synced: 2025-01-03T00:31:15.237Z (7 days ago)
- Topics: api-server, go, rest-api
- Language: Go
- Homepage:
- Size: 99.6 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# api
[![Godoc][godoc-image]][godoc-url]
[![Report][report-image]][report-url]
[![Tests][tests-image]][tests-url]
[![Coverage][coverage-image]][coverage-url]
[![Sponsor][sponsor-image]][sponsor-url]
Automatically implements your REST API.
## Usage
### Create an API instance
```go
myAPI := api.New("/api/", DB)
```
Parameters:
* The root of all your API routes
* A database handle that fulfills the [Database](Database.go) interface
### Install on an Aero app
```go
myAPI.Install(app)
```
This will register all API routes in the app.
## Routes
For the following examples we'll assume you have the type `Movie` registered in the database and that your API root is `/api/`. Type names are automatically lowercased for all routes.
### GET /api/movie/:id
Action: `get`
Fetches the object with the given ID from the database and shows the JSON representation.
Example response:
```json
```
If you need to filter out sensitive or private data you can implement the [Filter](Filter.go) interface on the data type.
### POST /api/movie/:id
Action: `edit`
Writes new data to the object with the given ID. The data needs to be a JSON-formatted `map[string]interface` where each key stands for a [path to a field](https://github.com/aerogo/mirror#getproperty) of this object. The data type needs to implement the [Editable](Editable.go) interface. Editable fields must be whitelisted with the tag `editable` using the value `true`.
Example request:
```json
```
Alternate example using advanced key paths:
```json
```
### POST /api/new/movie
Action: `create`
Create a new object of that data type. The data type needs to implement the [Creatable](Creatable.go) interface to register that route. Usually the post body contains a JSON-formatted key/value map which is used as the initial data for the new object.
Example request:
```json
```
It is up to the developer how the data is interpreted. This API library doesn't make any assumptions about the POST body in `create` requests.
## Style
Please take a look at the [style guidelines](https://github.com/akyoto/quality/blob/master/STYLE.md) if you'd like to make a pull request.
## Sponsors
| [](https://github.com/cedricfung) | [](https://github.com/soulcramer) | [](https://twitter.com/eduardurbach) |
| --- | --- | --- |
| [Cedric Fung](https://github.com/cedricfung) | [Scott Rayapoullé](https://github.com/soulcramer) | [Eduard Urbach](https://eduardurbach.com) |
Want to see [your own name here?](https://github.com/users/akyoto/sponsorship)
[godoc-image]: https://godoc.org/github.com/aerogo/api?status.svg
[godoc-url]: https://godoc.org/github.com/aerogo/api
[report-image]: https://goreportcard.com/badge/github.com/aerogo/api
[report-url]: https://goreportcard.com/report/github.com/aerogo/api
[tests-image]: https://cloud.drone.io/api/badges/aerogo/api/status.svg
[tests-url]: https://cloud.drone.io/aerogo/api
[coverage-image]: https://codecov.io/gh/aerogo/api/graph/badge.svg
[coverage-url]: https://codecov.io/gh/aerogo/api
[sponsor-image]: https://img.shields.io/badge/github-donate-green.svg
[sponsor-url]: https://github.com/users/akyoto/sponsorship