웹개발 종합반 2주차에서 배운 것 3/3

키워드 : jQuery, ajax-JSON, OpenAPI

OpenAPI

api : 응용프로그램이나 서비스를 개발하는데 필요한 운영체제(OS)나 라이브러리 등의 특정 기능을 추상화하여 사용하기 쉽도록 만든 인터페이스

Open api : Web 2.0 API, 통신망 서비스 API 등 주로 인터넷이나 통신망과 관련된 자원의 API를 의미하는 것으로, 여러 사람들이 공동으로 사용할 필요가 있는 자원에 대하여 이 자원의 사용을 개방하고, 사용자들이 자원에 대한 전문적인 지식이 없어도 쉽게 사용할 수 있도록 기능을 추상화하여 표준화한 인터페이스

공공데이터포털 https://www.data.go.kr/ugs/selectPublicDataUseGuideView.do
네이버 디벨로퍼스 https://developers.naver.com/docs/common/openapiguide/
구글 디벨로퍼스 https://developers.google.com/web/
카카오 디벨로퍼스 https://developers.kakao.com/docs
오픈웨더맵 https://openweathermap.org/
고양이 api https://thecatapi.com/

특히 프론트엔드는 다른 사람이 만든 api를 잘 사용할 수 있어야 한다.

api 문서화

백엔드와 프론트엔드 간의 협업을 위해 백엔드에서 작성해주는 문서다!
open API처럼 큰 api가 아니더라도 소규모 프로젝트라도, 협업시 있으면 서로에게 정말 편리한 문서다!

이러한 기능에 대해 내가 잘 알고 있으면 추후 백엔드 개발자님에게 이런걸 만들어달라고 할 수도 있고, 만들어주신 문서를 잘 읽을 수 있게 되면 api 분석하는데 들일 시간을 줄일 수도 있겠지.

엑셀 등을 사용하여 한땀 한땀 직접 만들 수도 있고,
라이브러리나 프레임워크를 사용하여 자동으로 구조화 할 수도 있는 것 같다.

1. Inline Documentation for RESTful web APIs : vscode 내에 import하여 사용

스웨거 https://swagger.io/

좀 무겁다고 하는 듯

api독 https://apidocjs.com/

스웨거보단 가볍다고 한다

2. 템플릿을 참고하여 .md = markdown 형식으로 레파지토리 내에 같이 올림

https://gist.github.com/iros/3426278

마크다운 api 문서의 예시 (깔끔하다!)

3. gitbook = workspace를 만들어 사용하는 공유메모장 같은거

https://www.gitbook.com/?t=1

정형화된 규격으로 api를 작성하게 해주며 실시간 업데이트가 가능한, 깃에서 개발한 사이트! 양측이 모두 깃북을 알고 있어야 한다는게 단점이지만 처음 잘 배워놓으면 커뮤니케이션이 무척 편리할 것 같다.

깃북에 대한 설명이 잘 된 블로그 https://velog.io/@city7310/%EB%B0%B1%EC%97%94%EB%93%9C%EA%B0%80-%EC%9D%B4%EC%A0%95%EB%8F%84%EB%8A%94-%ED%95%B4%EC%A4%98%EC%95%BC-%ED%95%A8-6.-API-%EC%8A%A4%ED%8E%99-%EC%84%A4%EA%B3%84%EC%99%80-%EB%AC%B8%EC%84%9C%ED%99%94-%EB%B0%A9%EC%8B%9D-%EA%B2%B0%EC%A0%95-2

4. txt나 엑셀을 이용하여 직접 제작

사실 형식이 딱 정해진건 아니라고 한다. 백엔드와 프론트엔드간에 커뮤니케이션만 잘 되면 괜찮다!