articles-api/README.md

# Articles API

This repository showcases the use of the [aicra](https://git.xdrm.io/go/aicra) API engine.

### 1. download and build the package

```bash
go get -u git.xdrm.io/go/articles-api
```

### 2. launch in docker

Build the image :
```bash
$ docker build -t articles-api .
```

Run the container :
```bash
$ 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](./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.
update architecture and remove heavy dependencies 2020-04-05 09:04:46 +00:00			`# Articles API`
first commit - half test with: +config +controllers -no_custom_type 2018-06-10 20:49:32 +00:00
update architecture and remove heavy dependencies 2020-04-05 09:04:46 +00:00			`This repository showcases the use of the [aicra](https://git.xdrm.io/go/aicra) API engine.`

			`### 1. download and build the package`
first commit - half test with: +config +controllers -no_custom_type 2018-06-10 20:49:32 +00:00
			```bash
update architecture and remove heavy dependencies 2020-04-05 09:04:46 +00:00			`go get -u git.xdrm.io/go/articles-api`
first commit - half test with: +config +controllers -no_custom_type 2018-06-10 20:49:32 +00:00			```

update readme according to new Dockerfile 2020-03-09 18:01:48 +00:00			`### 2. launch in docker`
first commit - half test with: +config +controllers -no_custom_type 2018-06-10 20:49:32 +00:00
update architecture and remove heavy dependencies 2020-04-05 09:04:46 +00:00			`Build the image :`
update readme according to new Dockerfile 2020-03-09 18:01:48 +00:00			```bash
update architecture and remove heavy dependencies 2020-04-05 09:04:46 +00:00			`$ docker build -t articles-api .`
first commit - half test with: +config +controllers -no_custom_type 2018-06-10 20:49:32 +00:00			```
update readme according to new Dockerfile 2020-03-09 18:01:48 +00:00
update architecture and remove heavy dependencies 2020-04-05 09:04:46 +00:00			`Run the container :`
update readme according to new Dockerfile 2020-03-09 18:01:48 +00:00			```bash
update architecture and remove heavy dependencies 2020-04-05 09:04:46 +00:00			`$ docker run -p 127.0.0.1:8888:4242 articles-api`
update readme 2018-10-01 19:37:22 +00:00			```

update readme according to new Dockerfile 2020-03-09 18:01:48 +00:00			You can now play with it with any regular REST API client at `127.0.0.1:8888`.
update readme 2018-10-01 19:37:22 +00:00
update architecture and remove heavy dependencies 2020-04-05 09:04:46 +00:00			`#### 2. Play with it`
update readme 2018-10-01 19:37:22 +00:00
update architecture and remove heavy dependencies 2020-04-05 09:04:46 +00:00			`The [api.json](./api.json) configuration file defines what this api provides, refer to it to know what requests are available.`
update readme 2018-10-01 19:37:22 +00:00
update architecture and remove heavy dependencies 2020-04-05 09:04:46 +00:00			`Examples :`
			- `GET /user/12` returns information about the user identified with 12.
			- `POST /article` given required parameters creates a new article.