An elegant way to write restful clients
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
src
.editorconfig
.gitignore
.npmignore
.travis.yml
LICENSE.md
README.md
package.json

README.md

Introduction

@t2ee/restful allows you to write restful clients that have verbal meanings, easy to read and easy to code.

For detailed introduction and examples, please visit core.t2ee.org.

Installation

npm i reflect-metadata @t2ee/core @t2ee/restful -S

Basic Example

interface Repository {
    id: number;
    name: string;
    //...
}

class GithubRepo {
    @GET('/users/{username}/repos')
    listUserRepos(@Path('username') username: string, @Query('type') type): Promise<Repository[]> {return null}
}

const builder = new RestfulService().baseUrl('https://api.github.com/');
const client = builder.create(GithubRepo);

const repos = await client.listUserRepos('t2ee', 'all');