2.6 KiB
2.6 KiB
restClient@0.0.1
This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:
Environment
- Node.js
- Webpack
- Browserify
Language level
- ES5 - you must have a Promises/A+ library installed
- ES6
Module system
- CommonJS
- ES6 module system
It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)
Building
To build and compile the typescript sources to javascript use:
npm install
npm run build
Publishing
First build the package then run npm publish
Consuming
navigate to the folder of your consuming project and run one of the following commands.
published:
npm install restClient@0.0.1 --save
unPublished (not recommended):
npm install PATH_TO_GENERATED_PACKAGE --save
Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| CardService | apiCardsIdNewPut | PUT /api/cards/{id}/new | Test |
| CardService | getCardById | GET /api/cards/{id} | Get a singular Card by its ID |
| CardService | getCardImageById | GET /api/cards/{id}/image | Get the image of a Card by its ID |
| CardService | getCards | GET /api/cards | Get a page of Cards with optional name query parameter |
| DeckService | addCardToDeck | POST /api/decks/{deckName}/{cardId} | Add a Card by its ID to a Deck by its name |
| DeckService | createDeck | POST /api/decks | Create a Deck with a given name |
| DeckService | getDeckByName | GET /api/decks/{name} | Get a singular Deck by its name |
| DeckService | getDecks | GET /api/decks | Get a page of Decks with optional name query parameter |
Documentation For Models
Documentation For Authorization
Endpoints do not require authorization.