Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • D Document
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
  • Packages and registries
    • Packages and registries
    • Container Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Create a new issue
  • Jobs
  • Issue Boards
Collapse sidebar
  • Technical-PortalTechnical-Portal
  • Document
  • Wiki
  • Api
  • Doc
  • content

content · Changes

Page history
Create API/doc/content authored Apr 27, 2020 by Yuying.Lo's avatar Yuying.Lo
Hide whitespace changes
Inline Side-by-side
API/doc/content.md 0 → 100644
View page @ 7ea3b0c8
# Doc
## <span class="" style="color:blue;">GET</span> /doc/content
### Description
根據使用者權限獲取文章內容
### Parameter
| Parameter | Description | Example | Parameter Type | Data Type |
| ----------|---------------| -------| -----| ------|
| docName | doc name,doc 的唯一名 | Guides\_and\_API\_References | query | string |
| version | 版本,或沒有指定則回所有版本 | v1.0.0 | query | string |
| lang | 語言key,或沒有指定則回傳英文版 | 1 | query | int |
### Response Body
``` javascript
{
"status": "success",
"docList": [
{
"version": "v1.0.2",
"artical": " ",
"link": " "
},
{
"version": "v1.0.3",
"artical": " ",
"link": " "
}
],
"lang": 1
}
```
##### Field
| Field Name | Description | Example | Data Type |
| -----------|---------------| -------| -------|
| status | 成功或失敗 | success | string |
| message | 失敗訊息 | Doc Name does not exist | string |
| docList | 文章陣列 | 如上範例 | array |
| docList[x].version | 版本 | v1.0.0 | string |
| docList[x].artical | 文章內文 | Guides... | string |
| docList[x].link | 連結,下載檔案的路徑或是外部連結 | http://advantech... | string |
| lang | 語言 | 1 | int |
Clone repository
  • API
    • doc
      • content
      • info
      • menu
  • Home