README
api_of_elsa_panel
ApiOfElsaPanel - JavaScript client for api_of_elsa_panel Restful api. This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.1.1
- Package version: 1.1.1
- Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit https://chenxl.cn/blog
Installation
Node.js
Fornpm
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install api_of_elsa_panel --save
git
https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:
If the library is hosted at a git repository, e.g. 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 ApiOfElsaPanel = require('api_of_elsa_panel');
var defaultClient = ApiOfElsaPanel.ApiClient.instance;
// Configure API key authorization: apiKey
var apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix['X-Auth-Token'] = "Token"
var api = new ApiOfElsaPanel.AlbumPanelApi()
var id = "id_example"; // {String} id
api.blockAlbum(id).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 https://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
ApiOfElsaPanel.AlbumPanelApi | blockAlbum | POST /panel/v1/album/{id}/action/block | 禁用指定相册 |
ApiOfElsaPanel.AlbumPanelApi | likesOfAlbum | GET /panel/v1/album/{id}/like | 获取指定相册的点赞记录 |
ApiOfElsaPanel.AlbumPanelApi | listAlbum | GET /panel/v1/album | 相册列表 |
ApiOfElsaPanel.AlbumPanelApi | setAlbumInVisible | POST /panel/v1/album/{id}/action/invisible | 取消公开指定相册 |
ApiOfElsaPanel.AlbumPanelApi | setAlbumVisible | POST /panel/v1/album/{id}/action/visible | 公开指定相册 |
ApiOfElsaPanel.AlbumPanelApi | showAlbum | GET /panel/v1/album/{id} | 获取指定相册信息 |
ApiOfElsaPanel.AlbumPanelApi | unblockAlbum | POST /panel/v1/album/{id}/action/unblock | 取消禁用指定相册 |
ApiOfElsaPanel.AppVersionPanelApi | createAppVersion | POST /panel/v1/appVersion | 创建版本 |
ApiOfElsaPanel.AppVersionPanelApi | disableAppVersion | POST /panel/v1/appVersion/{id}/disable | 禁用指定APP版本 |
ApiOfElsaPanel.AppVersionPanelApi | enableAppVersion | POST /panel/v1/appVersion/{id}/enable | 启用指定APP版本信息 |
ApiOfElsaPanel.AppVersionPanelApi | listAppVersion | GET /panel/v1/appVersion | APP版本列表 |
ApiOfElsaPanel.AppVersionPanelApi | showAppVersion | GET /panel/v1/appVersion/{id} | 获取指定APP版本信息 |
ApiOfElsaPanel.AuthPanelApi | byUsernameAndPassword | POST /panel/v1/auth | 用户名密码登录 |
ApiOfElsaPanel.BillPanelApi | listBill | GET /panel/v1/bill | 账单列表 |
ApiOfElsaPanel.BillPanelApi | showBill | GET /panel/v1/bill/{id} | 获取指定账单信息 |
ApiOfElsaPanel.FeedbackPanelApi | listFeedback | GET /panel/v1/feedback | 反馈列表 |
ApiOfElsaPanel.FolkPanelApi | listFolk | GET /panel/v1/folk | 用户列表 |
ApiOfElsaPanel.FolkPanelApi | showFolk | GET /panel/v1/folk/{id} | 获取指定用户信息 |
ApiOfElsaPanel.FontPanelApi | createFont | POST /panel/v1/font | 创建字体 |
ApiOfElsaPanel.FontPanelApi | deleteFont | POST /panel/v1/font/{fontId} | 删除字体 |
ApiOfElsaPanel.FontPanelApi | listFont | GET /panel/v1/font | 字体列表 |
ApiOfElsaPanel.GorillaPanelApi | createGorilla | POST /panel/v1/gorilla | 创建管理员 |
ApiOfElsaPanel.GorillaPanelApi | listGorilla | GET /panel/v1/gorilla | 管理员列表 |
ApiOfElsaPanel.GorillaPanelApi | me | GET /panel/v1/gorilla/me | 当前用户信息 |
ApiOfElsaPanel.MusicPanelApi | createMusic | POST /panel/v1/music | 创建音乐 |
ApiOfElsaPanel.MusicPanelApi | deleteMusic | POST /panel/v1/music/{musicId} | 删除音乐 |
ApiOfElsaPanel.MusicPanelApi | listMusic | GET /panel/v1/music | 音乐列表 |
ApiOfElsaPanel.PlanPanelApi | createPlan | POST /panel/v1/plan | 创建服务计划 |
ApiOfElsaPanel.PlanPanelApi | listPlan | GET /panel/v1/plan | 服务计划列表 |
ApiOfElsaPanel.PlanPanelApi | offPlan | POST /panel/v1/plan/{id}/off | 下架指定服务计划 |
ApiOfElsaPanel.PlanPanelApi | onPlan | POST /panel/v1/plan/{id}/on | 下架指定服务计划 |
ApiOfElsaPanel.PlanPanelApi | show | GET /panel/v1/plan/{id} | 获取指定服务计划信息 |
ApiOfElsaPanel.TradePanelApi | listTrade | GET /panel/v1/trade | 交易列表 |
ApiOfElsaPanel.TradePanelApi | showTrade | GET /panel/v1/trade/{id} | 获取指定交易信息 |
Documentation for Models
- ApiOfElsaPanel.AlbumLikeVO
- ApiOfElsaPanel.AlbumVO
- ApiOfElsaPanel.AppVersionVO
- ApiOfElsaPanel.AuthVO
- ApiOfElsaPanel.BillVO
- ApiOfElsaPanel.CreateAppVersionDTO
- ApiOfElsaPanel.CreateFontDTO
- ApiOfElsaPanel.CreateGorillaDTO
- ApiOfElsaPanel.CreateMusicDTO
- ApiOfElsaPanel.CreatePlanDTO
- ApiOfElsaPanel.FeedbackVO
- ApiOfElsaPanel.FolkVO
- ApiOfElsaPanel.FontVO
- ApiOfElsaPanel.Gorilla
- ApiOfElsaPanel.GorillaVO
- ApiOfElsaPanel.MusicVO
- ApiOfElsaPanel.PageAlbumLikeVO
- ApiOfElsaPanel.PageAlbumVO
- ApiOfElsaPanel.PageAppVersionVO
- ApiOfElsaPanel.PageBillVO
- ApiOfElsaPanel.PageFeedbackVO
- ApiOfElsaPanel.PageFolkVO
- ApiOfElsaPanel.PageFontVO
- ApiOfElsaPanel.PageGorillaVO
- ApiOfElsaPanel.PageMusicVO
- ApiOfElsaPanel.PagePlanVO
- ApiOfElsaPanel.PageTradeVO
- ApiOfElsaPanel.PlanVO
- ApiOfElsaPanel.R
- ApiOfElsaPanel.RAlbumVO
- ApiOfElsaPanel.RAppVersionVO
- ApiOfElsaPanel.RAuthVO
- ApiOfElsaPanel.RBillVO
- ApiOfElsaPanel.RFolkVO
- ApiOfElsaPanel.RFontVO
- ApiOfElsaPanel.RGorillaVO
- ApiOfElsaPanel.RMusicVO
- ApiOfElsaPanel.RPageAlbumLikeVO
- ApiOfElsaPanel.RPageAlbumVO
- ApiOfElsaPanel.RPageAppVersionVO
- ApiOfElsaPanel.RPageBillVO
- ApiOfElsaPanel.RPageFeedbackVO
- ApiOfElsaPanel.RPageFolkVO
- ApiOfElsaPanel.RPageFontVO
- ApiOfElsaPanel.RPageGorillaVO
- ApiOfElsaPanel.RPageMusicVO
- ApiOfElsaPanel.RPagePlanVO
- ApiOfElsaPanel.RPageTradeVO
- ApiOfElsaPanel.RPlanVO
- ApiOfElsaPanel.RTradeVO
- ApiOfElsaPanel.RVoid
- ApiOfElsaPanel.SimpleGrantedAuthority
- ApiOfElsaPanel.Sort
- ApiOfElsaPanel.TradeVO
- ApiOfElsaPanel.UsernamePasswordDTO
Documentation for Authorization
apiKey
- Type: API key
- API key parameter name: X-Auth-Token
- Location: HTTP header