메모장 쓰기 API

v4

목차

1. API 개요

2. 구조 및 응답

   2-1. 전송 구조

   2-2. 수신 구조

   2-3. 응답 및 오류

3. 레퍼런스 코드

🟢 1. API 개요

메모장을 작성할 수 있는 API 입니다.

작성된 메모 내용은 별도의 해시 코드로 불러올 수 있습니다.

🟢 2. 구조 및 응답

• 요청 URL : https://api.lrl.kr/v4/note/write
• 데이터 타입 : JSON
• 전송 메소드 : POST

POST 메소드로 전송하며 JSON 타입 데이터를 주고 받습니다.

🔵 2 - 1. 전송 구조

{ 
    content: "<p><b>굵게</b></p><p><u>밑줄</u></p><p><font color=\"#000000\" style=\"background-color: rgb(255, 255, 0);\">형광펜</font></p>"
}

content 값에 데이터를 넣어서 보냅니다.

🔵 2 - 2. 수신 구조

{
     "result": {
          "hash":"GR0gV09i"
     },
     "message":"SUCCESS"
}

hash 값이 해당 메모의 해쉬값입니다.

https://n.lrl.kr/GR0gV09i 에서 확인 가능하며, 메모장 읽기 API 에서도 확인 가능합니다.

🔴 2 - 3. 응답 및 오류

API 는 아래와 같은 http 코드로 응답합니다.

정상적인 응답에는 http 201 값을 반환합니다.

• 200 - 서비스 정상 제공중
• 201 - 요청 성공
• 400 - 잘못된 요청
• 403 - 접근 불가능
• 404 - 존재하지 않는 리소스
• 405 - 잘못된 요청 메소드
• 500 - 서버 오류. 신고 및 문의 게시판에 제보해주세요.

만약 오류가 난 경우 message 값에 다음 메세지를 반환합니다.

• ERR_NO_CONTENT : 빈 메모입니다. 내용을 작성해주세요.
• ERR_UNDEFINED : 알 수 없는 오류. 신고 및 문의 게시판에 제보해주세요.

🟢 3. 레퍼런스 (예제) 코드

레퍼런스는 참고자료 라는 뜻으로, API 사용 예제를 보여줍니다.

코드 수정은 자유입니다.

레퍼런스는 https://api.lrl.kr/ref/v4/ 에서 확인하실 수 있습니다.

크롬 우클릭 -> 페이지 소스 보기 를 눌러서 코드를 확인하세요.

또는 크롬 브라우저에 view-source:https://api.lrl.kr/ref/v4/ 를 입력하시면 소스 코드가 나옵니다.