Pengenalan kepada spesifikasi antara muka yang tenang dan alat penyahpepijat posmen

Saya baru-baru ini mempelajari spesifikasi antara muka RESTful dan memperkenalkannya menggunakan Postman Di sini saya akan merekodkan spesifikasi antara muka RESTful yang berkaitan:

1.

REST: Ia ialah gaya seni bina untuk perkhidmatan web menggunakan piawaian dan protokol yang popular seperti HTTP, URI, XML, JSON, HTML, dll.; reka bentuk seni bina bahasa ; Ia adalah gaya reka bentuk, bukan standard, tetapi idea.

REHAT: Bahasa Cina yang sepadan adalah gaya rehat; Seni Bina Berorientasikan) [Disyorkan: bahagian hadapan web]

Intipati RESTful ialah gaya seni bina perisian, terasnya berorientasikan sumber dan masalah yang diselesaikannya:

• Kurangkan kerumitan pembangunan
• Tingkatkan kebolehskalaan sistem

2. Perbezaan antara SOAP dan REST:
SOAP ( Simple Object Access Protocol ): Spesifikasi protokol untuk menukar data Ia adalah protokol berasaskan XML yang ringan, ringkas.
REST (Pemindahan Negeri Perwakilan): Gaya seni bina perisian yang boleh mengurangkan kerumitan pembangunan dan meningkatkan kebolehskalaan sistem.

Kecekapan dan kemudahan penggunaan:
SOAP: Disebabkan pengembangan berterusan kandungan protokolnya sendiri disebabkan oleh pelbagai keperluan, prestasi SOAP pemprosesan telah bertambah baik. Pada masa yang sama, kemudahan penggunaan dan kos pembelajaran juga meningkat.
REHAT: Oleh kerana reka bentuk antara muka berorientasikan sumber dan abstraksi operasi, ia memudahkan reka bentuk buruk pembangun, dan juga menggunakan maksimum konsep reka bentuk protokol aplikasi asal HTTP.

Keselamatan:
REHAT sangat sesuai untuk antara muka perkhidmatan berasaskan sumber, dan amat sesuai untuk keperluan kecekapan tinggi tetapi keperluan keselamatan yang rendah. Kematangan
SOAP boleh membawa kemudahan kepada reka bentuk antara muka yang perlu disediakan untuk berbilang bahasa pembangunan dan mempunyai keperluan keselamatan yang lebih tinggi.
Ringkasnya:
Keselamatan: SABUN akan menjadi lebih baik daripada REST; Ijazah
: Secara umumnya, SABUN adalah lebih baik daripada REHAT dari segi kematangan.
3. Cara mereka bentuk RESTful API :

Laluan sumber : Dalam seni bina RESTful, setiap URL mewakili sumber, Oleh itu, URL tidak boleh mempunyai kata kerja, hanya kata nama. Secara umumnya, kata nama dalam API hendaklah berbentuk jamak.
Kata kerja HTTP

: Untuk operasi sumber (CURD), diwakili oleh kata kerja HTTP (predikat).

DAPATKAN: Dapatkan sumber (satu atau lebih item) daripada pelayan. POST: Cipta sumber baharu pada pelayan.

PUT: Kemas kini sumber pada pelayan (pelanggan menyediakan sumber diubah lengkap).
• PADAM: Padamkan sumber daripada pelayan.
• Mari kita ambil zoo sebagai contoh (termasuk maklumat tentang pelbagai haiwan dan pekerja):

POST /zoo: Buat zoo baharu

DAPATKAN /zoos/ID: Dapatkan maklumat zoo tertentu

https://api.example.com/v1/zoos //动物园资源
https://api.example.com/v1/animals //动物资源
https://api.example.com/v1/employees //雇员资源

PUT /zoos/ID: Kemas kini maklumat zoo tertentu
DELETE /zoos/D: Padamkan zoo tertentu Zoo
• Tapis maklumat

:

?limit=10: Nyatakan bilangan rekod yang dikembalikan ?offset=10: Menentukan kedudukan permulaan rekod yang dikembalikan.

?page=2&per_page=100: Tentukan halaman dan bilangan rekod bagi setiap halaman.
?sortby=name&order=asc: Tentukan atribut yang mana hasil yang dikembalikan diisih mengikut, dan susunan pengisihan.
?animal_type_id=1: Tentukan syarat penapis
• Kod status

:

200 (OK ) - jika sumber sedia ada telah ditukar 201 ( dicipta ) - jika sumber baharu dicipta

202 ( diterima ) - permintaan pemprosesan telah diterima tetapi belum selesai (tak segerak pemprosesan)
301 (Dipindahkan Secara Kekal)-URI sumber dikemas kini
303 (Lihat Lain)-Lain-lain (seperti pengimbangan beban)
400 (permintaan buruk )-Merujuk kepada permintaan buruk
404 (tidak ditemui)-Sumber tidak wujud
406 (tidak boleh diterima)-Pelayan tidak menyokong perwakilan yang diperlukan
409 (konflik)-Konflik umum
412 (Prasyarat Gagal)-Prasyarat gagal (seperti konflik semasa melaksanakan kemas kini syarat)
415 (jenis media tidak disokong)-Perwakilan yang diterima tidak disokong
500 (ralat pelayan dalaman ) - Respons ralat generik
503 (Perkhidmatan Tidak Tersedia) - Perkhidmatan pada masa ini tidak dapat memproses permintaan
• Ralat pengendalian

:

Maklumat yang dikembalikan menggunakan ralat sebagai nama kunci dan maklumat ralat sebagai nilai kunci.

Keputusan pulangan

{
 error: “Invalid API key”
 }

:

• GET /collection：返回资源对象的列表（数组）
• GET /collection/resource：返回单个资源对象
• POST /collection：返回新生成的资源对象
• PUT /collection/resource：返回完整的资源对象
• PATCH /collection/resource：返回完整的资源对象
• DELETE /collection/resource：返回一个空文档

4.REST风格的接口测试流程：
我们直接用一张图来介绍吧
5.代码编写和Postman测试：
工具：idea，mysql数据库，Postman
数据库表数据：

实体类：

@Data
@ApiModel("用户实体类")
public class User extends Model<User> implements Serializable {
    @ApiModelProperty("用户id")
    @NotNull(message = "用户id不能为空")
    private Integer id;

    @NotBlank(message = "用户名不能为空")
    @ApiModelProperty("用户名")
    private String name;

    @Min(1)
    @Max(100)
    @ApiModelProperty("用户年龄")
    private Integer age;

    @NotEmpty(message = "邮箱不能为空")
    @ApiModelProperty("用户邮箱")
    @Email
    private String email;

    @ApiModelProperty("0:未删除 1：已删除")
    @TableLogic
    private Integer deleted;

    @NotBlank(message = "密码不能为空")
    @ApiModelProperty("用户密码")
    private String password;
    }

controller层的代码（service层省略）：

@Api(tags = "用户管理")
@RestController
@RequestMapping("/MyWebsite/user")
public class UserController {
    @Autowired
    private UserServiceImpl userServiceimpl;

   @ApiOperation(value = "新增用户")
    @PostMapping
    public int insertUser(User user) {

        System.out.println("新增成功");

        return userServiceimpl.insertUser(user);
    }

    @ApiOperation(value = "修改用户信息")
    @PutMapping
    public void updateUser(@RequestBody @Valid User user) {

        userServiceimpl.updateUser(user);

        System.out.println("修改成功");
    }

    @ApiOperation(value = "删除用户", notes = "根据id删除用户")
    @DeleteMapping("/{id}")
    public int deleteUser(@ApiParam("用户id") @PathVariable @Valid Integer id) {

        System.out.println("删除成功");

        return userServiceimpl.deleteUser(id);
    }

    @ApiOperation(value = "查询所有用户")
    @GetMapping
    public List<User> allUser() {

        System.out.println("查询成功");

        return userServiceimpl.allUser();
    }

    @ApiOperation(value = "id查询用户")
    @GetMapping("/{id}")
    public User selectById(@PathVariable("id") String id) {
        return userServiceimpl.selectById(id);
    }
}

利用Postman测试（url路径要对应上）：
查询所有用户：http://localhost:8081/MyWebsite/user
Header：Content-Type=application/json
Body：空

查询成功！
根据id查询：

查询成功！
新增用户：

查看数据库新增成功！

修改用户信息（修改id为7的姓名和年龄）：

查看数据库修改成功！

根据id删除用户：

查看数据库删除成功！（deleted=1）
可能你的是直接删除了整一条数据

当查询或更新或删除不存在的数据时（或者数据不合法），都是执行失败的
还有其他接口，例如删除所有等接口，这里不一一测试了
若有不正确的地方，欢迎指出。

Atas ialah kandungan terperinci Pengenalan kepada spesifikasi antara muka yang tenang dan alat penyahpepijat posmen. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!