Adrien Marquès 1fb2a210a1 | ||
---|---|---|
service | ||
storage | ||
.gitignore | ||
README.md | ||
api.json | ||
go.mod | ||
go.sum | ||
main.go |
README.md
xdrm go framework
1. Setup
You need a redis
server running, if you don't have it, you can simply use a docker container for it with docker run -p 6379:6379 -d redis
.
All commands above must be launched from the root of this repository.
2. Build type checkers, controllers, middlewares
Type checkers, controllers and middlewares have to be compiled beforehand. A build command exists for that purpose.
aicra <project-folder>
3. Launch the api
$ go run ./main.go
Now you can play with it with any regular REST API client at 127.0.0.1:4242
.
1. Get an authentication token
POST /token/admin
to get an authentication token.
2. Manage tiny urls
The authentication token must be set inside the
Authorization
header of each request except for theGET
method.
POST /<some-url>
to set a new tiny-url for the url<some-url>
to redirect to the FORM variable namedtarget
. Also you can send the FORM data as x-www-form-urlencoded, form-data or json.PUT /<some-url>
to update an existing tiny-url for the url<some-url>
to redirect to the FORM variable namedtarget
.DELETE /<some-url>
to delete the tiny-url for<some-url>
.GET /<some-url>
to redirect to the target of an existing url `.