API Documentation Best Practices Course

API 문서화. 누군가가 이미 만들어 놓은 API 에 추가하는것은 5분컷인데, 처음 바닥부터 시작하려고 하면 갑자기 막막해집니다. 어떻게 시작하는게 좋고 어떤 문서화가 좋은 문서화 일까요?


2시간 짜리 강의라 짧진 않지만, Business Impact, Security Review 등 빼먹지 말아야할 사항까지 꼼꼼히 짚어주고 있어, 연휴에 시간 될때 정주행하면 뼈가 되고 살이 될 것 같습니다 :))


https://www.freecodecamp.org/news/api-documentation-best-practices-course

API Documentation Best Practices Course

freeCodeCamp.org

API Documentation Best Practices Course

더 많은 콘텐츠를 보고 싶다면?

또는

이미 회원이신가요?

2023년 12월 24일 오전 7:52

 • 

저장 251조회 8,427

댓글 1

  • API 간닫한거 부터 많이 작성해 봐야 합니다. 누가 만들어 놓은 API라도 자기 코드화 해 보세요 일단 분석 부터 그리고 이걸 내꺼화 시켜서 많이 작성 하다보면 자연스럽게 DB구조만 보고 API작성 하게 되더라구요. 처움에는 문서도 자동화 해서 찍어주는거 말고 워드 열어서 직접 작성해 보시구요 그 다음에 POSTMAN 깉은 앱으로 API 테스트 해 보면서 문서 어떻게 나오는지 확인 해 보고 내가 작성한 문서랑 비교도 해보고 수정해 나가고 이렇게 한달만 조금 고생해서 하다보면 그 다음에는 언제 내가 API를 이렇게 빠르게 만들었지 하면서 늘게 될거에요 저 같은 경우도 처음에는 APi 어떤 패턴으로 짜야 되나 감이 안올때 미리 만들어 져 있던 API를 자세히 분석 먼저 했어요 그 다음에는 복붙이 아니라 직접 하나 하나 타이핑 해서 본인코드화 시키니 하루에 API 10개는 그냥 만들어 버려요 그후에 수정 할거는 디테일 하게 수정하고 뭐 이런. 아무튼 잘 만들어진 API를 많이 보고 분석 하는게 중요한거 같습니다 그리고 번인 스타일을 만들어 보세요 정답이란건 없어요 본인 스타일로 만든 코드가 최적화 되어서 잘 작동 하면 그게 정답이 될 수 있어요

함께 읽은 게시물

QA 구직/이직을 위한 이력서 작성 팁

... 더 보기

 • 

댓글 1 • 저장 28 • 조회 2,822


< 일 잘하는 PM은 문제의 ‘이름’부터 정의한다 >

1

... 더 보기

 • 

댓글 1 • 저장 20 • 조회 1,195


건강관리에 비유한 프로젝트 위험관리

개인의 건강관리와 프로젝트의 위험관리는 유사한 점이 많다.

... 더 보기

🍜 짜파게티가 왜 거기서 나와?

... 더 보기

GPT-5가 출시되면서 Function Calling에 Free-Form Function Calling과 Context-Free Grammar (CFG)를 지원하는데, 이게 숨은 보석이다.


Free-Form은 결과를 JSON이 아니라 SQL, Python script 등의 코드등을 결과로 받거나 XML, CSV 같은 형태로도 받을 수 있다. 다만 plain-text로 주는 형태라서 주의가 필요하다. 이건 예전에도 프롬프트 트릭으로 쓰곤했던거라 그냥 맘이 좀 편해졌다(?)정도.

... 더 보기

넷플릭스는 왜 WebFlux를 사용하지 않을까?

... 더 보기

넷플릭스는 왜 WebFlux를 사용하지 않을까?

kr.linkedin.com

넷플릭스는 왜 WebFlux를 사용하지 않을까?