API 문서 형식

공부/기본

qlek1108 2023. 11. 3. 09:54

API(application programming interface :응용 프로그램 프로그래밍 인터페이스)

- 서로 다른 소프트웨어 또는 하드웨어 간에 상호작용을 가능하게 하는 연결고리

- api를 어떻게 사용해야 하는지에 대한 가이드

- 개요

- 엔드포인트 : api에서 제공하는 url들을 명시, 각각의 엔드포인트는 특정 데이터에 접근하거나 특정 작업을 수행하는 데 사용

- 메소드 : 각 엔드포인트에서 사용 가능한 http메소드 ( GET, POST, PUT, DELETE,,)를 명시

- 요청 예제 : 각 엔드포인트와 메소드에 대한 요청 예제를 제공, 개발자들은 실제 요청을 어떻게 구성해야 하는지 이해할 수 있다

- 응답 예제 : API 요청에 대한 예상 응답. 이를 통해 개발자들은 API가 반환하는 데이터 형식을 이해할 수 있다

- 오류 코드

- 보안정보

헤더 : 메타데이터 제공 (어떤 형식으로 데이터가 있을지,, 등등)

바디 : 실제 결과 데이터

헤더에 토큰값을 넣어서 보내는 경우가 있다 이 경우가 인증, 인가 과정에서 발생을 한다

토큰이란..

인증 : 사용자가 누구인지 확인하는 과정

인가 : 사용자가 특정 자원에 접근할 권한이 있는지 확인하는 과정

Method	PATH	Get	Request	Response
GET	/users	사용자 목록 조회	-	[{ "id":1, "name":"김철수", "email":"chulsoo@example.com" }, { "id":2, "name":"박영희", "email":"younghee@example.com" }]
GET	/users/1	특정 사용자 조회	-	{ "id":1, "name":"김철수", "email":"chulsoo@example.com" }
POST	/users	사용자 생성	{ "name":"이영희", "email":"younghee@example.com" }	{ "id":3, "name":"이영희", "email":"younghee@example.com" }
PUT	/users/1	사용자 정보 수정	{ "name":"김철수수정", "email":"chulsoo@example.com" }	{ "id":1, "name":"김철수수정", "email":"chulsoo@example.com" }
DELETE	/users/1	사용자 삭제	-	{ "message": "User with id: 1 deleted successfully" }

이건 그냥 내가 이해할려고 적는거

request - input

response - output

path - url, 쿼리문