go
/
articles-api
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Simple articles REST API using the aicra engine
52 Commits 1 Branch 1 Tag 100 KiB
Go 93.4%
Dockerfile 6.6%
Go to file
Adrien Marquès 16204b1d93
continuous-integration/drone/push Build is passing Details
continuous-integration/drone/tag Build is passing Details
update architecture and remove heavy dependencies 		2020-04-05 11:04:46 +02:00
pkg update architecture and remove heavy dependencies 2020-04-05 11:04:46 +02:00
.drone.yml ci: simplify 2019-05-04 00:08:38 +02:00
.gitignore update architecture and remove heavy dependencies 2020-04-05 11:04:46 +02:00
Dockerfile docker: use entrypoint instead of cmd 2020-03-09 19:16:27 +01:00
LICENSE add license 2020-03-29 17:37:10 +02:00
README.md update architecture and remove heavy dependencies 2020-04-05 11:04:46 +02:00
api.json update architecture and remove heavy dependencies 2020-04-05 11:04:46 +02:00
go.mod update architecture and remove heavy dependencies 2020-04-05 11:04:46 +02:00
go.sum update architecture and remove heavy dependencies 2020-04-05 11:04:46 +02:00
main.go update architecture and remove heavy dependencies 2020-04-05 11:04:46 +02:00

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.