---
# System prepended metadata

title: APIDOG

---

# Overview 
Apidog 是用於設計、測試等功能的 API 開發平台，幫助團隊建立並管理 API，
也可透過模擬功能，使前端開發無需等待後端，提升整體開發效率。

## Environment Setting
![image](https://hackmd.io/_uploads/BkM1_UTWel.png)
![image](https://hackmd.io/_uploads/ryfGd8TWgg.png)

## API e.g.
`以 Custom HTTP header API 為例`
- 建立新 API
  - 在目的資料夾中，點選「Add Endpoint」
  - 選擇 POST method
  - URL 輸入：/customhttpheader.cgi (若已設定 Environment)

- 設定 authentication
  - 點選 Request > Auth
  - 選擇 Basic Auth
  - Set Username and Password

- 設定 Headers
  - 點選 Request > Headers
  - Name `Content-Type`
  - Example `application/json`

- 設定 Body
  - 點選 Request > Body > JSON
  - 將 ListCustomHeaders.json 內容複製到 Example

- Run API
  - 右上選擇 Environment (AXIS)
  - 執行 API ， Run > Send
  - 選擇 Headers 查看 Header 和對應 Value
  
  | mod       | content                                  |
  | --------- | ---------------------------------------- |
  | Pretty    | 顯示美化後格式，類似 `jq .` 效果             | 
  | Raw       | 顯示無美化格式 (原始檔案)                    |
  | Preview   | 瀏覽器渲染效果顯示，適合 HTML、圖片、PDF 等格式 |
  | Visualize | 視覺化腳本渲染，適合圖表、報表、進階資料 等格式  |
  
  ![image](https://hackmd.io/_uploads/r1tqkvTZle.png)

:::info
- 若在未設定 Proxy ，於瀏覽器執行時會失敗
![image](https://hackmd.io/_uploads/ByXXJwpZee.png)
- 若使用 APP ，開啟 OpenVPN 連線，可成功執行
:::
