react_antd_admin_rest_api
v0.0.0
Published
a_standard_restful_api_for_project_react_antd_admin
Downloads
5
Readme
react_antd_admin_rest_api
ReactAntdAdminRestApi - JavaScript client for react_antd_admin_rest_api a standard restful api for project react-antd-admin This SDK is automatically generated by the Swagger Codegen project:
- API version: 0.0.0
- Package version: 0.0.0
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen
Installation
For Node.js
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install react_antd_admin_rest_api --save
git
If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
npm install GIT_USER_ID/GIT_REPO_ID --save
For browser
The library also works in the browser environment via npm and browserify. After following
the above steps with Node.js and installing browserify with npm install -g browserify
,
perform the following (assuming main.js is your entry file):
browserify main.js > bundle.js
Then include bundle.js in the HTML pages.
Webpack Configuration
Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:
module: {
rules: [
{
parser: {
amd: false
}
}
]
}
Getting Started
Please follow the installation instruction and execute the following JS code:
var ReactAntdAdminRestApi = require('react_antd_admin_rest_api');
var api = new ReactAntdAdminRestApi.AuthenticationApi()
var userInfo = new ReactAntdAdminRestApi.UserInfo(); // {UserInfo} user info for authenticate
api.postAuthentication(userInfo).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
Documentation for API Endpoints
All URIs are relative to http://localhost:30000/api/v1
Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- ReactAntdAdminRestApi.AuthenticationApi | postAuthentication | POST /authentication | post username and password ReactAntdAdminRestApi.BillionairesApi | billionairesGet | GET /billionaires | list of the world's billionaires
Documentation for Models
- ReactAntdAdminRestApi.BillionairesNetWorth
- ReactAntdAdminRestApi.BillionairesRanking
- ReactAntdAdminRestApi.InlineResponse200
- ReactAntdAdminRestApi.InlineResponse2001
- ReactAntdAdminRestApi.UserInfo
Documentation for Authorization
api_key
- Type: API key
- API key parameter name: api-key
- Location: HTTP header