[웹 API 디자인] 1. 소개

소개

만약 이 글을 읽고 있다면, 웹 API를 개발자들이 좋아할 수 있도록 디자인하고, 검증된 디자인 원칙과 최상의 실천 방법을 적용하는 것에 관심이 있을 것입니다.

우리 디자인의 기반이 되는 것 중 하나는 REST입니다. REST는 엄격한 표준이 아닌 아키텍처 스타일이기 때문에 많은 유연성을 가지고 있습니다. 이러한 유연성과 구조적 자유 때문에, 디자인 최상의 실천 방법에 대한 큰 욕구가 있습니다.

이 전자책은 우리가 Apigee에서 제공하는 디자인 워크숍을 통해 API 전략을 구상하는 세계 최고 API 팀 중 일부와 협력하여 개발한 디자인 실천 방법의 모음입니다.

우리는 API 디자인에서 개발자의 성공을 다른 디자인 원칙보다 우선시하는 “실용적인 REST”라는 시각을 가지고 있습니다. 개발자는 웹 API의 고객입니다. API 디자인의 성공은 개발자가 빨리 익숙해지고 API를 사용하여 성공을 경험할 수 있는 빠른 시간 안에 측정됩니다.

의견을 주시면 감사하겠습니다 - 동의하거나 동의하지 않거나 추가적인 실천 방법과 팁이 있다면 공유해 주세요. API Craft Google Group은 웹 API 디자인 애호가들이 모여 디자인 실천 방법을 공유하고 논의하는 곳입니다. 여러분을 거기서 만나 보고 싶습니다.

너는 실용주의자(Pragmatist)인가 RESTafarian인가?

API 디자인에 대한 전반적인 시각에서 시작해보자. 우리는 규범주의적이지 않은 실용적인 REST를 지지합니다. 규범주의적이란 무엇을 의미할까요?

진정한 REST에 대한 토론 글을 본 적이 있을 것입니다 - 그 중 일부는 상당히 엄격하고 난해할 수 있습니다. Mike Schinkel은 RESTafarian을 다음과 같이 정의합니다.

“RESTifarian은 Roy T. Fielding의 UC Irvine 박사 학위 논문 제 5장에서 정의된 REST 소프트웨어 아키텍처 스타일의 열렬한 지지자입니다. RESTifarian은 REST-discuss 메일링 목록에서 찾을 수 있습니다. 하지만 조심하세요, RESTifarian은 REST의 미세한 점들에 대해 매우 꼼꼼할 수 있습니다…”

우리의 견해: ‘바깥에서 안으로’의 관점에서 API 디자인에 접근합니다. 이것은 API로 무엇을 달성하려고 하는지 먼저 물어보는 것으로 시작한다는 것을 의미합니다.

API의 역할은 개발자를 가능한 한 성공시키는 것입니다. API를 위한 방향성은 응용 프로그램 개발자의 관점에서 디자인 선택 사항을 생각하는 것입니다.

왜냐하면, 아래의 가치 사슬을 보면 알 수 있듯이, 애플리케이션 개발자는 전체 API 전략의 중심 인물입니다. API를 만들 때 주요 디자인 원칙은 개발자 생산성과 성공을 극대화하는 것이어야 합니다. 이를 우리는 실용적인 REST라고 부릅니다.

실용적인 REST는 디자인 문제입니다.

디자인은 어떻게 사용될지를 전달하기 때문에 디자인을 올바르게 해야 합니다. 디자인의 핵심 질문은 애플리케이션 개발자에게 최적의 이점을 제공하는 디자인이 무엇인가입니다. 모든 구체적인 팁과 모범 사례는 개발자의 시각을 지향하는 지침 원칙입니다.