# Postman 使用教學

## 前言

講解 Postman 較常使用特別的功能，像是如何下載檔案之類的。

## 目錄

* [介紹/基本概念](#介紹/基本概念)
* [建立下載檔案](#建立下載檔案)
* [怎麼下載檔案](#怎麼下載檔案)
* [Postman 旁邊小視窗功能](#Postman-旁邊小視窗功能)
* [Authentication](#Authentication)
* [參考資料](#參考資料)

## 介紹/基本概念

### 建立下載檔案

#### TXT

##### 建立 RestController

@RestController
public class APIController {


    @GetMapping("/txt")
    public String getTxt(HttpServletResponse response){
        String fileName = "test.txt";
        response.setHeader("Content-Disposition", "attachment; filename=" + fileName);
        response.setContentType("application/txt");
        String content = "This is txt content";

        return content;
    }

}

* Header : Content-Disposition
attachment : 開新視窗下載
filename : 檔案名稱
* Content-Type : 設定下載檔案格式
例如 : application/txt ， application/jpg

##### TXT 檔案格式

This is txt content

#### JSON

##### 1. 建立 Food.java

public class Food {
    private Long id;

    private String name;

    public Food(Long id, String name) {
        this.id = id;
        this.name = name;
    }

    public Food() {
    }

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

##### 2. 建立 RestController

@RestController
public class APIController {
    @GetMapping(value = "/json",produces = MediaType.APPLICATION_JSON_VALUE)
    public Food getJson(){
        return new Food(1L,"FORK");
    }
}

:::info
🔔 RestController 預設格式是 JSON，所以可以不用寫
produces =MediaType.APPLICATION_JSON_VALUE
:::

##### JSON 檔案格式

{
    "id": 1,
    "name": "FORK"
}

#### XML

接續以上下載JSON

##### 1. pom.xml 新增

<dependency>
  <groupId>com.fasterxml.jackson.dataformat</groupId>
  <artifactId>jackson-dataformat-xml</artifactId>
</dependency>

這樣才可以使用XML

##### 2.建立 RestController

@RestController
public class APIController {
    @GetMapping(value = "/xml",produces = MediaType.APPLICATION_XML_VALUE)
    public Food getXML(){
        return new Food(1L,"FORK");
    }
}

##### XML 檔案格式

<Food>
    <id>1</id>
    <name>FORK</name>
</Food>

### 怎麼下載檔案

#### Postman 下載檔案


1. 呼叫 API ( Send )
2. 點選 Save Response
3. 選擇 Save to a file
即可下載檔案

##### 下載結果

###### TXT 檔



###### JSON 檔



###### XML 檔



### Postman 旁邊小視窗功能

#### Documetation


可以撰寫到底這個 API 這麼使用的一些文件

#### Code snippet


可以直接複製各式語言常用呼叫 API 程式碼
會直接對應現在 Postman 使用 API
Java 則提供 Okhttp 和 Unirest 的範例程式碼

##### 1. OKHttp

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("127.0.0.1:8080/txt")
  .method("GET", body)
  .build();
Response response = client.newCall(request).execute();

##### 2. Unirest

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("127.0.0.1:8080/txt")
  .asString();

要取用 API 的時候，可以直接複製 Code snippet 的內容。

### Authentication

#### Basic Auth


使用 username 和 password 組成認證碼，呼叫 API

缺點是 Server 只能確認帳號密碼，無法控制例如登入時效（ session ），只能靠 browser 的 cookie expiration

#### Bearer


可使用 Token 來驗證 API ， Bearer Token 並沒有規定的建立方法，
只要最後 server 能 verify 就可以了。
以 JWT 的 Token 為例，Token 可以夾帶比較多使用者資訊
JWT 的 Token 是由 Server 所產生的， Client 不會知道如何建立這 Token

## 參考資料

[開發者必備知識 - HTTP認證（HTTP Authentication）](https://carsonwah.github.io/http-authentication.html)

[Spring Boot Rest XML example – Web service with XML Response
](https://www.bezkoder.com/spring-boot-rest-xml/)

## 撰寫紀錄

| 人員 | 日期 | 修改紀錄 |
| -------- | -------- | -------- |
| 禮惟 | 2022/9 | 初版 |