athena_creator_writer_apis v1.0.7
athena_creator_writer_apis
AthenaCreatorWriterApis - JavaScript client for athena_creator_writer_apis 内容云AI智能创作 APIs This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0-SNAPSHOT
- Package version: 1.0.0-SNAPSHOT
- Build package: org.openapitools.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 athena_creator_writer_apis --save
Finally, you need to build the module:
npm run build
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
To use the link you just defined in your project, switch to the directory you want to use your athena_creator_writer_apis from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
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 AthenaCreatorWriterApis = require('athena_creator_writer_apis');
var api = new AthenaCreatorWriterApis.AICreationApi()
var opts = {
'createWritingRequest': new AthenaCreatorWriterApis.CreateWritingRequest() // {CreateWritingRequest}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.createWriting(opts, callback);
Documentation for API Endpoints
All URIs are relative to http://localhost:8080/api/v1
Class | Method | HTTP request | Description |
---|---|---|---|
AthenaCreatorWriterApis.AICreationApi | createWriting | POST /writings | 创建自动化创作文案 |
AthenaCreatorWriterApis.AICreationApi | getTemplate | GET /templates/{id} | 查询创作模板详情 |
AthenaCreatorWriterApis.AICreationApi | getWriting | GET /writings/{id} | 查询自动化创作文案详情 |
AthenaCreatorWriterApis.AICreationApi | listArticles | GET /articles | 检索自动化创作的文本列表 |
AthenaCreatorWriterApis.AICreationApi | listTemplates | GET /templates | 检索创作模板列表 |
AthenaCreatorWriterApis.AICreationApi | listWritings | GET /writings | 检索自动化创作文案列表 |
AthenaCreatorWriterApis.AICreationApi | templateOptions | OPTIONS /templates | 创作模板API说明 |
AthenaCreatorWriterApis.AICreationApi | updateArticle | PUT /articles/{id} | 修改自动化生成的文本的内容 |
Documentation for Models
- AthenaCreatorWriterApis.Article
- AthenaCreatorWriterApis.ArticleList
- AthenaCreatorWriterApis.CreateWritingRequest
- AthenaCreatorWriterApis.CreateWritingRequestEssentialsParameters
- AthenaCreatorWriterApis.CreateWritingRequestFreestyleParameters
- AthenaCreatorWriterApis.CreateWritingRequestMarketingParameters
- AthenaCreatorWriterApis.ErrorBody
- AthenaCreatorWriterApis.EssentialsParameters
- AthenaCreatorWriterApis.FaultBody
- AthenaCreatorWriterApis.FreestyleParameters
- AthenaCreatorWriterApis.InlineResponseDefault
- AthenaCreatorWriterApis.MarketingParameters
- AthenaCreatorWriterApis.Model
- AthenaCreatorWriterApis.Ordering
- AthenaCreatorWriterApis.Pagination
- AthenaCreatorWriterApis.Template
- AthenaCreatorWriterApis.TemplateList
- AthenaCreatorWriterApis.TemplateStatus
- AthenaCreatorWriterApis.TitleGenerationParameters
- AthenaCreatorWriterApis.UpdateArticleRequest
- AthenaCreatorWriterApis.Writing
- AthenaCreatorWriterApis.WritingList
Documentation for Authorization
ApiKeyAuth
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
BearerAuth
- Type: Bearer authentication (Bearer)