웹훅 기능을 테스트 하기 좋은 도구들 소개
마이크로서비스 환경에서는 API로 메시지를 주고 받게 마련이다. 이런 API는 단순히 요청(Request)을 던져서 응답(Response)을 기다리는 방식이 대부분이지만 좀 더 긴 처리시간을 필요로 하는 경우도 있을 수 있고, 하나의 워크플로우...
API
마크다운 문서화 도입기
최근에 신규 프로젝트를 들어가면서 DB와 API 설계를 담당하고 있는데 일반적으로 DB 설계는 설계 후 산출물을 가지고 검토를 받고, API는 설계 산출물을 가지고 클라이언트 개발자(앱과 웹) 전달해서 연동할 때...
JSON API Specification v1.0 (3) – Document Structure (4)
검증 (Identification) 모든 resource object는 id 멤버와 type 멤버는 포함하고 있어야 합니다. <MUST> id와 type 멤버 값은 문자열이어야 합니다. <MUST> Every resource object MUST contain an id member and...
JSON API Specification v1.0 (3) – Document Structure (3)
5.2. 리소스 오브젝트 (Resource Objects) “리소스 오브젝트”는 자원을 나타내는 데 사용되는 JSON API에 표시됩니다. “Resource objects” appear in a JSON API document to represent resources. 리소스 오브젝트는 적어도 다음 최상위 멤버가...
JSON API Specification v1.0 (3) – Document Structure (2)
5.1. 최상위 (Top Level) JSON 오브젝트는 데이터를 포함한 JSON API 요청과 응답에 대한 근본(root) 입니다. <MUST> 이 오브젝트를 문서의 “최상위”라 정의합니다. A JSON object MUST be at the root of...
JSON API Specification v1.0 (3) – Document Structure (1)
5. 문서 구조 (Document Structure) 이 세션에서는 미디어 타입 application/vnd.api+json에서 확인가능한 JSON API 문서 구조에 대해 설명합니다. JSON API 문서는 JavaScript Object Notation (JSON) RFC7159에 정의 되어있습니다. This section describes...
JSON API Specification v1.0 (2)
JSON API를 사용하는 서버와 클르이언트에서 처리를 해야되는 것들에 대해서 이야기한다. 4. 컨텐츠 처리 (Content Negotiation) 클라이언트 의무 사항 (Client Responsibilities) 클라이언트는 해더에 Content-Type: application/vnd.api+json를 포함하고 다른 미디어 타입 매개변수를 포함하지 않는...
JSON API Specification v1.0 (1)
JSON API 문서이다. 해당 문서는 여기서 확인이 가능하다. 라이센스는퍼블릭 도메인 라이센스. 나중에 번역한 것이 도움이 되길 바라며… 1. 문서 상태 (Status) 이 페이지는 JSON API 마지막으로 공개된 버전 내용을 담고...
sys.json
EricR/sys.json 좀 독특하다고 해야되나? Golang을 이용해서 웹을 간단히 띄우고, proc 를 이용해서 내용들을 불러와 JSON 형태로 뽑아주도록 되어있다. 몇몇 부분을 수정하거나 작업을 해야되긴 하겠지만 이 정도로 작은 아이를 띄워 무리없이...
RESTful API Design: what about errors? | Apigee Blog
RESTful API Design: what about errors? | Apigee Blog: 왜 에러디자인이 중요한가? API를 직관적으로 보이게 하고, 개발자를 도와준다. 에러라는 것은 그 API를 어떻게 써야 하는지에 대한 이해를 돕는다. ...