tiny-url-ex/README.md

# xdrm go framework

### 1. Download and build the package

```bash
go get -u git.xdrm.io/go/tiny-url-ex
```

### 2. launch the server

```
$ go run .
```

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 the `GET` method which does not require you to be authenticated.

- `POST /<some-url>` to set a new tiny-url for the url `<some-url>` to redirect to the FORM variable named `target`. 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 named `target`.
- `DELETE /<some-url>` to delete the tiny-url for `<some-url>`.
- `GET /<some-url>` to redirect to the target of an existing url `<some-url>`.
first commit - half test with: +config +controllers -no_custom_type 2018-06-10 20:49:32 +00:00			`# xdrm go framework`

update readme 2020-03-03 19:06:09 +00:00			`### 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 readme 2020-03-03 19:06:09 +00:00			`go get -u git.xdrm.io/go/tiny-url-ex`
first commit - half test with: +config +controllers -no_custom_type 2018-06-10 20:49:32 +00:00			```

update readme 2020-03-03 19:06:09 +00:00			`### 2. launch the server`
first commit - half test with: +config +controllers -no_custom_type 2018-06-10 20:49:32 +00:00
			```
update readme 2020-03-03 19:06:09 +00:00			`$ go run .`
update readme 2018-10-01 19:37:22 +00:00			```

			Now you can play with it with any regular REST API client at `127.0.0.1:4242`.

			`##### 1. Get an authentication token`
update readme 2020-03-03 19:06:09 +00:00
update readme 2018-10-01 19:37:22 +00:00			- `POST /token/admin` to get an authentication token.

			`#### 2. Manage tiny urls`

update readme 2020-03-03 19:06:09 +00:00			> The authentication token must be set inside the `Authorization` header of each request except for the `GET` method which does not require you to be authenticated.
update readme 2018-10-01 19:37:22 +00:00
			- `POST /<some-url>` to set a new tiny-url for the url `<some-url>` to redirect to the FORM variable named `target`. 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 named `target`.
			- `DELETE /<some-url>` to delete the tiny-url for `<some-url>`.
update readme 2020-03-03 19:06:09 +00:00			- `GET /<some-url>` to redirect to the target of an existing url `<some-url>`.