Introduction to restful interface specification and postman debugging tool

I recently learned the RESTful interface specification and introduced it using Postman. Here I will record the relevant RESTful interface specification:

1. What is RESTful?

REST: is an architectural style for web services; uses widely popular standards and protocols such as HTTP, URI, XML, JSON, HTML, etc.; lightweight, cross-platform, and cross-language architectural design ; It is a design style, not a standard, but an idea.

RESTful: The corresponding Chinese is rest-style; Restful web service is a common rest application, which is a web service that complies with rest style; rest-style web service is a kind of ROA (The Resource- Oriented Architecture) [Recommended: web front-end]

The essence of RESTful is a software architecture style, the core is resource-oriented, and the problems it solves:

• Reduce the complexity of development
• Improve the scalability of the system

2. The difference between SOAP and REST:
SOAP ( Simple Object Access Protocol): A protocol specification for exchanging data. It is a lightweight, simple, XML-based protocol.
REST (Representational State Transfer): A software architecture style that can reduce the complexity of development and improve the scalability of the system.

Efficiency and ease of use:
SOAP: Due to the continuous expansion of the content of its own protocol due to various needs, the performance of SOAP processing has improved. decline. At the same time, the ease of use and learning costs have also increased.
RESTful: Due to its resource-oriented interface design and operation abstraction, it simplifies developers' bad designs and also makes the most of the original application protocol design concept of HTTP.

Security:
RESTful is very suitable for resource-based service interfaces. It is also particularly suitable for high efficiency requirements but not high security requirements. scene. The maturity of
SOAP can bring convenience to the interface design that needs to be provided for multiple development languages ​​and has higher security requirements.
In short:
Security: SOAP will be better than REST;
Efficiency and ease of use: REST is better;
Maturity Degree: Generally speaking, SOAP is superior to REST in terms of maturity.

3. How to design RESTful API:
Resource path: In RESTful architecture, each URL represents a resource, Therefore, the URL cannot have verbs, only nouns. Generally speaking, nouns in APIs should be plural.

HTTP verb: Operations on resources (CURD) are represented by HTTP verbs (predicates).

• GET: Get the resource (one or more items) from the server.
• POST: Create a new resource on the server.
• PUT: Update resources on the server (the client provides the changed complete resources).
• DELETE: Delete resources from the server.

Let’s take the zoo as an example (including information about various animals and employees):

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

• POST /zoos: Create a new zoo
• GET /zoos/ID: Get information about a specified zoo
• PUT /zoos/ID: Update information about a specified zoo
• DELETE /zoos/D: Delete a zoo

Filter information:

• ?limit=10: Specify the number of returned records
• ? offset=10: Specifies the starting position of the returned record.
• ?page=2&per_page=100: Specify the page and the number of records on each page.
• ?sortby=name&order=asc: Specify which attribute the returned results are sorted by, and the sorting order.
• ?animal_type_id=1: Specify filter conditions

Status code :

• 200 (OK ) - If an existing resource has been changed
• 201 ( created ) - If a new resource is created
• 202 ( accepted ) - The processing request has been accepted but has not been completed (asynchronous processing)
• 301 (Moved Permanently)-The URI of the resource is updated
• 303 (See Other)-Others (such as load balancing)
• 400 (bad request)-Refers to a bad request
• 404 (not found )-The resource does not exist
• 406 (not acceptable)-The server does not support the required representation
• 409 (conflict)-General conflict
• 412 (Precondition Failed)-The precondition failed (such as a conflict when executing condition update)
• 415 (unsupported media type)-The received representation is not supported
• 500 (internal server error ) - Generic error response
• 503 (Service Unavailable ) - The service is currently unable to process the request

Error handling :
The returned information uses error as the key name and error information as the key value.

{
 error: “Invalid API key”
 }

Return result：

• 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）
可能你的是直接删除了整一条数据

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

The above is the detailed content of Introduction to restful interface specification and postman debugging tool. For more information, please follow other related articles on the PHP Chinese website!