API 문서(우편배달부 포함)

Have you ever written a bunch of code that you find difficult to recognize after a couple of weeks or months?

Have you spent ample time trying to figure out what a particular endpoint does and how to use it on the frontend?

대다수의 경험이 있는 프로그래머들은 이 문제들에 대해 "예"라고 대답할 것이다.그럼 문제는 어디에서 나올까요?문서!
네, 문서는 프로그래밍의 중요한 구성 부분입니다. 프로그래밍은 보통 늦게 가르치거나 배우기 어렵습니다. 앞에서 지적한 바와 같이.문서는 우리의 코드, 즉 단독 문서(예를 들어github의 자술)에서 우리의 코드를 평론하거나 우리의 코드나 응용 프로그램을 보고할 수 있습니다.본문에서 우리는postman을 어떻게 사용하여 후자를 실현하는지 토론할 것이다.
Postman는 일반적으로 개발자가 API의 유효성과 효율을 테스트하는 데 도움을 주는 도구로 불린다.하지만 네가 할 수 있다면 그뿐만이 아니다check them out here.우체부는 장래에 사용할 수 있도록 코드를 기록해 줄 것이다.어떻게 써요?이것이 바로 우리가 본문에서 대답할 문제다.

어떻게 우체부와 함께 API를 기록합니까

이 점을 보여주기 위해서 우리는 우리가 있는 것을 사용할 것이다.우리는 heroku에서 이번 활동을 주재했다.전화번호link입니다.
register endpoint로 데모

청구

당신의 우체부를 찾아가세요create new request.

주소 표시줄에 https://nodejs-mongodb-auth-app.herokuapp.com/register를 입력합니다.

요청동사를 POST로 변경합니다.

요청 본문에 다음 내용을 입력하십시오

{
    "email": "[email protected]",
    "password": "password"
}

클릭send 버튼

이러한 성공적인 응답을 출력해야 한다:

요청 및 응답 저장

버튼 옆에 Send 버튼이 있습니다.그것을 클릭하세요.이렇게 하면 다음과 같은 저장 요청 대화 상자가 나타납니다.

요청 이름 변경Save

Register Endpoint에 다음을 입력합니다.

## This request registers a user using **email** and **password**

* No validation necessary

아래에서 Request Description 단추를 눌러 폴더를 만듭니다.이름 말하기+ Create Collection

클릭auth-tutorial 화살표

저장

지금 당신에게 요구하는 버튼이 있습니다correct

요청을 저장하려면 클릭합니다.우리가 만든 것처럼 왼쪽 표시줄에서 집합을 볼 수 있을 것입니다

너무 멋있어!
하지만 우리는 다른 개발자와 미래의 자신을 돕기 위해 더 많은 일을 할 수 있다.다른 개발자와 우리의 미래에 대한 기대를 쉽게 말할 수 있도록 이 요청의 예를 추가합시다.

예 추가

우리가 추가하고자 하는 예는 우리가 방금 제기한 요구이다.이거 봐.

응답 주체에 앞서 save to auth-tutorial 링크를 클릭하고 save response를 선택합니다.(새 탭에서 열어야 함)

샘플 탭에서 이름을 save as example

로 변경합니다.

클릭Register Endpoint Example을 통해 예제를 끝점에 추가

이렇게우리는 이미 이 종점을 기록했다.우리는 심지어 언제든지 Save Example 패널에서 그것에 접근할 수 있다.
그런데 이 문서들을 다른 사람과 공유하고 싶다면?
우리 갑시다.

문서 공유

패널로 이동하고 collections 집합의 메뉴 아이콘을 클릭합니다.이것은 다음과 같은 메뉴일 것입니다:

클릭collections옵션.로그인하지 않은 경우 로그인하라는 메시지가 표시되고 로그인하지 않은 경우 계정을 만들라는 메시지가 표시됩니다.

절차에 따라 로그인하거나 계정을 생성합니다.그리고 우리는 계속

컬렉션에서 오른쪽 화살표를 클릭합니다.대화상자가 나타날 것 같습니다

auth-tutorial버튼을 클릭합니다.

이렇게 하면 레코드를 표시하는 엔드포인트의 브라우저로 리디렉션됩니다.너는 나를 조사할 수 있다here

축하해!!!이것은 위대한 발이다. 너는 이미 도달했다

결론

문서의 중요성은 아무리 강조해도 지나치지 않다.우리는 우리의 API를 기록하는 것이 얼마나 중요하고 쉬운지 이미 보았다.
현재 우리는 Share Collection로 프레젠테이션을 진행했는데 auth-tutorial로 시도할 수 있는지 확인했습니다.다음 필수 데이터를 참조하십시오.

endpoint url: https://nodejs-mongodb-auth-app.herokuapp.com/register
request body:

{
    "email": "[email protected]",
    "password": "password"
}

읽어주셔서 감사합니다.