Skip to content

Latest commit

 

History

History
168 lines (145 loc) · 6.39 KB

api정보.md

File metadata and controls

168 lines (145 loc) · 6.39 KB

access token

"x-access-token: dauqsedoc"

request URL

GET http://link.codesquad.co.kr/v1

response

{
  "links": {
    "docs": [
      {
        "_id": "5daa9a977b5ae100079d475e",
        "author": "",
        "title": "현지화",
        "description": "현지화에 대해서 실습을 따라하며 알아볼 수 있는 사이트",
        "category": "iOS",
        "url": "https://devmjun.github.io/archive/Localization",
        "metadata": "{\"title\":\"Swift. Internationalizing Your iOS App: Getting Started\",\"description\":\"\",\"type\":\"\",\"url\":\"/archive/Localization\",\"site_name\":\"Home\",\"image\":{\"url\":\"img/tags/Swift-bg.jpg\"}}",
        "__v": 0
      },
      {
        "_id": "5d9210af7b5ae100079d475d",
        "author": "",
        "title": "마블 보는 사이트",
        "description": "마블로 연산자들을 이해할 수 있는 사이트입니다.",
        "category": "swift",
        "url": "https://rxmarbles.com/#zip",
        "metadata": "{\"title\":\"RxMarbles: Interactive diagrams of Rx Observables\"}",
        "__v": 0
      },
      {
        "_id": "5d73779ef420240007a0c287",
        "author": "도미닉",
        "title": "키보드 내리는 방법",
        "description": "",
        "category": "iOS",
        "url": "http://kiljh.me/2019/08/29/keyboardDown/",
        "metadata": "{\"title\":\"\"}",
        "__v": 0
      },
      {
        "_id": "5d6dd3ae1090ae0007a7c998",
        "author": "Nailer",
        "title": "Node.js의 내부 동작 원리",
        "description": "Nailer 뇌피셜 믿을만한 정리글",
        "category": "backend",
        "url": "https://sjh836.tistory.com/149",
        "metadata": "{\"type\":\"article\",\"url\":\"https://sjh836.tistory.com/149\",\"site_name\":\"빨간색코딩\",\"title\":\"nodejs의 내부 동작 원리 (libuv, 이벤트루프, 워커쓰레드, 비동기)\",\"description\":\"참조문서 https://github.com/nodejs/node https://nodejs.org/ko/docs/guides/event-loop-timers-and-nexttick/ https://medium.com/the-node-js-collection/what-you-should-know-to-really-understand-the-node..\",\"image\":{\"url\":\"https://img1.daumcdn.net/thumb/R800x0/?scode=mtistory2&fname=https%3A%2F%2Ft1.daumcdn.net%2Fcfile%2Ftistory%2F997A063B5AD8B56E05\"},\"regDate\":\"20180420002916\"}",
        "__v": 0
      },
      {
        "_id": "5d6dc13e1090ae0007a7c997",
        "author": "Nailer",
        "title": "배포 자동화와 무중단 배포!",
        "description": "Travis CI, AWS Code deploy, Docker",
        "category": "backend",
        "url": "https://velog.io/@jeff0720/Travis-CI-AWS-CodeDeploy-Docker-로-배포-자동화-및-무중단-배포-환경-구축하기",
        "__v": 0
      },
      {
        "_id": "5d6cbd901090ae0007a7c996",
        "author": "Nailer",
        "title": "좋은 node.js개발자가 되는 방법들",
        "description": "영문사이트입니당",
        "category": "backend",
        "url": "https://medium.com/@me_37286/19-ways-to-become-a-better-node-js-developer-in-2019-ffd3a8fbfe38#09a3",
        "metadata": "{\"site_name\":\"Medium\",\"type\":\"article\",\"title\":\"19 ways to become a better Node.js developer in 2019\",\"description\":\"Strategic ideas for things you should learn to create robust Node.js & Javascript application in 2019\",\"url\":\"https://medium.com/@me_37286/19-ways-to-become-a-better-node-js-developer-in-2019-ffd3a8fbfe38\",\"image\":{\"url\":\"https://miro.medium.com/max/1200/1*WNBUtTzkDqn-uzP8vPcvpw.jpeg\"}}",
        "__v": 0
      },
      {
        "_id": "5d663fa41090ae0007a7c995",
        "author": "도미닉",
        "title": "WKWebView 와 스크립트 실행 방법",
        "description": "",
        "category": "iOS",
        "url": "http://kiljh.me/2019/08/28/WKUserScript/",
        "metadata": "{\"title\":\"WKWebView\",\"description\":\"도미닉 블로그\",\"site_name\":\"Dominic Blog\",\"type\":\"article\",\"image\":{\"url\":\"https://kiljh.mehttp://www.codeblocq.com/assets/projects/hexo-theme-clean-blog/img/home-bg.jpg\"}}",
        "__v": 0
      },
      {
        "_id": "5d6614981090ae0007a7c994",
        "author": "Nailer",
        "title": "iOS 스토리보드 없이 CRUD하기",
        "description": "스토리보드 없이 crud 셋팅편",
        "category": "iOS",
        "url": "https://baked-corn.tistory.com/54",
        "metadata": "{\"type\":\"article\",\"url\":\"https://baked-corn.tistory.com/54\",\"site_name\":\"이동건의 이유있는 코드\",\"title\":\"[ios] 스토리보드 없이 CRUD - Setting\",\"description\":\"스토리보드 없이 CRUD - Setting 안녕하세요. 오늘부터 간단한 CRUD 프로젝트를 만들어보도록 하겠습니다. 웬만한 웹 어플리케이션과 모바일 어플리케이션에는 기본적으로 CRUD가 들어가게 됩니다. CRUD의 약자는..\",\"image\":{\"url\":\"https://img1.daumcdn.net/thumb/R800x0/?scode=mtistory2&fname=https%3A%2F%2Ft1.daumcdn.net%2Fcfile%2Ftistory%2F998316465A391F3A11\"},\"regDate\":\"20171215144716\"}",
        "__v": 0
      },
      {
        "_id": "5d65e7115e751a0007e929f2",
        "author": "도미닉",
        "title": "json 받아오는 2가지 방법",
        "description": "",
        "category": "swift",
        "url": "http://kiljh.me/2019/08/19/networkProgramming/",
        "metadata": "{\"title\":\"네트워크에서 Json 데이터 가져오기\",\"description\":\"도미닉 블로그\",\"site_name\":\"Dominic Blog\",\"type\":\"article\",\"image\":{\"url\":\"https://kiljh.mehttp://www.codeblocq.com/assets/projects/hexo-theme-clean-blog/img/home-bg.jpg\"}}",
        "__v": 0
      }
    ],
    "totalDocs": 15,
    "limit": 9,
    "hasPrevPage": false,
    "hasNextPage": true,
    "page": 1,
    "totalPages": 2,
    "pagingCounter": 1,
    "prevPage": null,
    "nextPage": 2
  },
  "categories": [
    "all",
    "backend",
    "frontend",
    "iOS",
    "swift"
  ]
}

parameters

author - 특정 author의 게시물들을 보고 싶을 때

page - 다음 페이지, 지정한 페이지로 넘어갈 경우 페이지를 query parameter 지정

category - 특정 카테고리만 보여줄 때

Request URL

POST http://link.codesquad.co.kr/v1/link

request body (JSON)

{
  "author": "nailer"
  "title": "nailer title",
  "description": "nailer description",
  "category": "iOS",
  "url": "www.nailer.co.kr/somethinggood"
}

response

201
{ 
	"message": "Link Created!"
}

500
{
  "message": "Link Creation Error"
}