66. Rest API

박선규

Apr 01, 2024

Contents

Rest API

🏤

Rest(좋은 URL을 지정하여 명확한 엔드포인트를 설정하여) API(메서드를 구현하여 URL로 사용자가 접속 했을 때 자원이 나오게끔 만드는 것)

Rest

🏤

주소 설계의 디자인 원칙이다

좋은 주소 설계를 해야지 명확하게 확인 할 수 있다.

GET,POST,PUT,DELTE 이 어노테이션들과 URL Rest의 해당한다.

REST API URL 규칙

API 개발을 하는데 있어서 URI를 어떻게 명명할지에 대한 정리를 하기 위해 포스팅 하였다. 1. RESTful API 란 Rest : Representational State Tranfer의 약자로 웹을 이용할때 제약조건들을 정의하는 소프트웨어 아키텍처 스타일. HTTP URL 을 통해서 자원(Resource)을 명시하고 HTTP Method(GET, POST, PUT, DELETE)를 통해 해당 자원(URL)에 대한 CRUD를 적용하는 것을 의미한다. 한마디로 HTTP의 장점을 살리고자 하는 통신규약 2. REST 특징 인터페이스 일관성 : 일관적인 인터페이스로 분리되어야 한다. 무상태 : 각 요청간 클라이언트의 context, 세션과 같은 상태 정보를 서버에 저장하지 않는다. 캐시 처리 기능 : ..

https://dev-cool.tistory.com/32

설계원칙 1.소문자만 사용한다.

2.언더바 대신 하이픈을 사용한다

3.마지막에 슬래시를 포함하지 않는다.

4.행위를 포함하지 않는다.(예외로 사용해야하는 경우가 있다. (아이디 중복체크))

5.파일 확장자는 URL에 포함시키지 않는다.

6.전달하고자 하는 명사를 사용하되, 컨트롤 자원을 의미하는 경우 예외적으로 동사를 사용한다.

7.URI에 작성되는 영어를 복수형으로 작성한다.

API( Application Programming Interface)

📌

애플리케이션이나 디바이스가 서로간에 연결하여 통신 할 수 있는 방법을 정의 하는 규칙으로

블루투스 기계가 하나 있으며 컴퓨터에 연결해서 통신하고 싶다. 여기서 개발자의 역할은 블르투스 기계가 컴퓨터랑 연결 시켜주는 것이랑 사용자가 어떻게 사용하면 되는지를 알려주는것이 api인거고 어떤식으로 통신하는지는 내부 동작을 구체적으로 알 필요는 없다.

블루투스 기기를 컴퓨터와 연결하는 방법을 이해하고 구현하는 것: 이를 위해 블루투스 통신을 위한 API를 사용하여 기기를 컴퓨터에 연결하고 데이터를 주고받을 수 있는 코드를 작성합니다.

사용자가 어떻게 블루투스 기기와 컴퓨터를 사용할 수 있는지를 알려주는 것: 이를 위해 API를 통해 사용 방법에 대한 문서화를 제공하거나, 사용자 인터페이스(UI)를 통해 사용자가 블루투스 기기를 컴퓨터와 연결하고 데이터를 주고받을 수 있도록 안내합니다.

JavaSpringFrameWork