Adrien Marquès
16204b1d93
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/tag Build is passing
Details
|
||
---|---|---|
pkg | ||
.drone.yml | ||
.gitignore | ||
Dockerfile | ||
LICENSE | ||
README.md | ||
api.json | ||
go.mod | ||
go.sum | ||
main.go |
README.md
Articles API
This repository showcases the use of the aicra API engine.
1. download and build the package
go get -u git.xdrm.io/go/articles-api
2. launch in docker
Build the image :
$ docker build -t articles-api .
Run the container :
$ docker run -p 127.0.0.1:8888:4242 articles-api
You can now play with it with any regular REST API client at 127.0.0.1:8888
.
2. Play with it
The api.json configuration file defines what this api provides, refer to it to know what requests are available.
Examples :
GET /user/12
returns information about the user identified with 12.POST /article
given required parameters creates a new article.