반응형 API4 api 문서화, 좋은 예시 0. api 자급자족할 때는 딱히 신경쓰지 않았는데, 간만에 다른 사람이 쓸지도 모르는 상황이 돼서, api 문서화를 찾아봤다. 1. swaggerhttps://swagger.io/ 이전 회사에서 쓰던 api 문서화 프레임워크. 베트남에 안드로이드/아이폰 어플 만드는 외주를 맡겼었는데 이 swagger가 정말 유용했다. 우리쪽에서 api를 만든 뒤, swagger를 업데이트해서 주면 따로 말로 설명할 필요가 없었다. 다만, 처음 사용이 좀 복잡하고...경우에 따라 작성/수정에 좀 오래 걸릴 수도 있다. django에 swagger 관련 모듈이 있다! 근데 사용법을 잘 몰라서 몇 번 끼적여보다가 포기. 간지나던데...다음에 다시 도전! 2. Asciidoctorhttp://asciidoctor.org/As.. 2017. 10. 31. [AWS] API Gateway로 API를 만들어보자 3 : Lambda 함수 만들기 나는 facebook의 휴나지움(연세대 공학원 학생식당) 페이지에서 메뉴를 긁어왔는데 그냥 def sum(x, y): result = x + y return result 이런 함수를 만들어도 괜찮다. 일단은 API를 만들어보고 이해하기 위함이니까... 내 코드는 이렇다. _hunasiu,_menu()는 당연히 휴나지움의 메뉴를 str 형식으로 긁어오는 함수다. 중요한 것은 lambda_handler()다. 이건 함수명도 굉장히 중요한데, [AWS] API Gateway로 API를 만들어보자 2 에서 미리 말한 바 있지만, AWS Lambda에서 아래와 같은 식으로 handler를 정의해야 하기 때문이다. 어쨌든 저렇게 하고 이를 zip 파일로 만들어 업로드하면 된다. ** pip을 사용해 기본 라이브러리.. 2016. 11. 30. [AWS] API Gateway로 API를 만들어보자 2 : Lambda 활용하기 API Gateway에서 API의 구조를 갖췄다. 그러면 이제 API가 호출될 때 가져올 데이터를 실행하는 함수가 필요하다. 이때 AWS Lambda를 사용한다.(프로그래밍 언어로 사용되는 lambda와는 다르다.) AWS Console에서 Lambda 페이지에 들어간다. Get Started Now!! 이런 복잡한 화면이 나오면 침착하게 왼쪽 상단에서 본인이 사용할 언어를 선택한다. Node.js 4.3과 Python 2.7을 사용할 수 있다.(내 기억엔 java도 있었는데...안 보인다.) 다 좋은데 Python3을 쓰지 못한다는 엿같은 단점이 있다. 무튼 Python을 선택하고 오른쪽 아래 보이는 hello-world-python을 선택한다. 이런 화면이 뜰 것이다. 우린 API Gateway로 A.. 2016. 11. 30. [AWS] API Gateway로 API를 만들어보자 1 : API 틀 갖추기 Amazon API Gateway를 이용해 API를 만들어보자. 맨 처음 써봤을 때는 헷갈렸는데 한 번 익히고 나면 그다지 어렵지 않다. **본 문서는 AWS Lambda를 기반으로 한다. AWS 콘솔에서 Amazon API Gateway 페이지로 들어간다. 아무것도 만들지 않았다면 아래와 같은 화면이 나타날 것이다. 그럼 Start! New API를 선택하자. 혹시 Swagger를 사용할 줄 안다면 Swagger로! Swagger는 API document라고 할 수 있는데, 갖춰진 틀만 따르면 손쉽게 API를 만들 수 있다. 여러 명이서 API 작업을 할 경우, Swagger를 통해 버전 관리를 하면 편하다. 나는 페이스북에서 학생식당 메뉴를 얻어올 API를 만들 것이기 때문에 API이름을 YumYum.. 2016. 11. 30. 이전 1 다음 반응형
