Restful 인터페이스 사양 및 Postman 디버깅 도구 소개-JS 튜토리얼-php.cn

최근에 RESTful 인터페이스 사양에 대해 알아보고 Postman을 사용하여 소개했습니다. 여기에 관련 RESTful 인터페이스 사양을 기록하겠습니다.

REST: HTTP, URI, XML, JSON, HTML 등과 같이 널리 사용되는 표준 및 프로토콜을 사용하는 웹 서비스용 아키텍처 스타일입니다. 이는 경량의 크로스 플랫폼, 크로스 언어 아키텍처 디자인입니다. ; 디자인입니다. 스타일은 표준이 아니라 아이디어입니다.

RESTful: 해당 중국어는 RESTful입니다. Restful 웹 서비스는 REST 스타일을 준수하는 웹 서비스인 일반적인 REST 애플리케이션입니다. RESTful 웹 서비스는 일종의 ROA(Resource-Oriented Architecture)입니다. ) [추천: 웹 프론트엔드] RESTful의 본질은 소프트웨어 아키텍처 스타일입니다. 핵심은 리소스 지향적이며 문제를 해결합니다.

개발 복잡성 감소

시스템 확장성 향상

2. SOAP와 REST의 차이점:

SOAP(Simple Object Access Protocol): 데이터 교환을 위한 프로토콜 사양으로, 가볍고 간단한 XML 기반 프로토콜입니다. REST(Representational State Transfer): 개발의 복잡성을 줄이고 시스템의 확장성을 향상시킬 수 있는 소프트웨어 아키텍처 스타일입니다.

효율성 및 사용 용이성

: SOAP
: 자체 프로토콜의 콘텐츠를 지속적으로 확장하는 다양한 요구로 인해 SOAP 처리 성능이 저하되었습니다. 동시에 사용 편의성과 학습 비용도 증가했습니다. RESTful
: 리소스 중심 인터페이스 설계 및 작업 추상화로 인해 개발자의 잘못된 설계를 단순화하고 HTTP의 원래 애플리케이션 프로토콜 설계 개념을 최대한 활용합니다.

Security

: RESTful
은 리소스 기반 서비스 인터페이스에 매우 적합하며 특히 효율성 요구 사항은 높지만 보안 요구 사항은 낮은 시나리오에 적합합니다. SOAP
의 성숙함은 여러 개발 언어에 제공되어야 하고 더 높은 보안 요구 사항을 갖는 인터페이스 디자인에 편의성을 가져올 수 있습니다. 간단히 말해서:
보안
: SOAP는 REST보다 우수합니다. 효율성과 사용 용이성
: REST가 더 좋습니다. 성숙도
: 일반적으로 SOAP는 성숙도 측면에서 REST보다 낫습니다.

3. RESTful API를 디자인하는 방법

:
리소스 경로: RESTful 아키텍처에서 각 URL은 리소스를 나타내므로 URL에는 동사가 없고 명사만 있을 수 있습니다. 일반적으로 API의 명사는 복수형이어야 합니다.

HTTP 동사: 리소스에 대한 작업(CURD)은 HTTP 동사(술어)로 표현됩니다.

GET: 서버에서 리소스(하나 이상의 항목)를 가져옵니다.

POST: 서버에 새 리소스를 만듭니다.
PUT: 서버의 리소스를 업데이트합니다(클라이언트는 변경된 전체 리소스를 제공합니다).
DELETE: 서버에서 리소스를 삭제합니다.
동물원을 예로 들어보겠습니다(다양한 동물 및 직원에 대한 정보 포함):

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

로그인 후 복사

POST /zoos: 새 동물원 만들기

GET /zoos/ID: 지정된 동물원에 대한 정보 가져오기
PUT / Zoos/ID: 지정된 동물원의 정보 업데이트
DELETE /zoos/D: 동물원 삭제

필터 정보:

?limit=10: 반환된 레코드 수 지정

?offset =10: 반환된 레코드의 시작 위치를 지정합니다.
?page=2&per_page=100: 페이지와 페이지당 레코드 수를 지정합니다.
?sortby=name&order=asc: 반환된 결과를 정렬할 속성과 정렬 순서를 지정합니다.
?animal_type_id=1: 필터 조건 지정

상태 코드 :

200(OK) - 기존 리소스가 변경된 경우

201( 생성됨 ) - 새 리소스가 생성된 경우
202 ( 수락 ) - 처리 요청이 수락되었지만 완료되지 않았습니다 (비동기 처리)
301 (영구적으로 이동됨) - 리소스의 URI가 업데이트되었습니다
303 ( 기타 참조 ) - 기타(로드 밸런싱 등)
400(잘못된 요청) -잘못된 요청을 참조
404(찾을 수 없음) -리소스가 존재하지 않습니다
406(허용되지 않음) -서버가 필요한 표현을 지원하지 않습니다
409(충돌) -일반적인 충돌
412(전제 조건 실패) - 전제 조건 실패(예: 조건 업데이트 실행 시 충돌)
415(지원되지 않는 미디어 유형) - 수신된 표현이 지원되지 않습니다.
500(내부 서버 오류) - 일반 오류 응답
503(서비스 사용할 수 없음) - 현재 서비스를 사용할 수 없습니다. 요청 처리

오류 처리 : 반환된 정보는 오류를 키 이름으로, 오류 정보를 키 값으로 사용합니다.

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

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