PHP 인터페이스 문서 작성 방법

1. HTTP가 정보를 전달하는 방법

url

headers

body: 요청 본문, 응답 본문 포함

2. 일반적으로 헤더의 정보는 보편적입니다. 기본 매개변수로 미리 명시해두세요

3. 경로의 매개변수 표현

URL의 매개변수 표현은 콧수염 형태를 사용하며 매개변수는 이중 중괄호 {{paramName}}

로 묶여 있습니다. 관련 추천: "

php 입문 튜토리얼

"

예:

/api/user/{{userId}}
/api/user/{{userType}}?age={{age}}&gender={{gender}}

4. 데이터 모델 정의

데이터 모델 정의에는 다음이 포함됩니다.

·

경로 및 쿼리 문자열 매개변수 모델

·

요청 본문 매개변수 모델

·

응답 본문 매개변수 모델

데이터 모델의 최소 데이터 집합:

Name

필요합니까

Description

“最小数据集”（MDS）是指通过收集最少的数据，较好地掌握一个研究对象所具有的特点或一件事情、一份工作所处的状态，
其核心是针对被观察的对象建立起一套精简实用的数据指标。最小数据集的概念起源于美国的医疗领域。最小数据集的产生源于信息
交换的需要，就好比上下级质量技术监督部门之间、企业与质量技术监督部门之间、质量技术监督部门与社会公众之间都存在着信息
交换的需求。

일부 문서에서는 필드 유형을 추가할 수 있지만 꼭 필요한 것은 아니라고 생각합니다. 필요한. HTTP로 전송되는 데이터는 직렬화해야 하는 경우가 많으며 대부분의 데이터 유형은 문자열이라고 생각됩니다. 열거 유형 문자열과 같은 일부 특수 유형은 설명에 설명될 수 있습니다.

추가: 테이블을 사용하여 데이터 모델을 나타내는 것이 좋습니다.

위 내용은 PHP 인터페이스 문서 작성 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!