Python에서 API 작성(Flask 및 RapidAPI 사용)

이 기사를 읽고 있다면 API(Application Programming Interface)를 사용할 때 열리는 가능성에 이미 익숙할 것입니다.

많은 공용 API 중 하나를 애플리케이션에 추가하여 이 애플리케이션의 기능을 확장하거나 필요한 데이터로 보완할 수 있습니다. 하지만 커뮤니티와 공유하고 싶은 고유한 기능을 개발했다면 어떨까요?

대답은 간단합니다. 나만의 API 만들기.

이것은 처음에는 어려운 작업처럼 보일 수 있지만 실제로는 매우 간단합니다. Python으로 이 작업을 수행하는 방법을 보여드리겠습니다.

시작하는 데 필요한 것

API 개발에는 다음이 필요합니다.

• 파이썬 3;
• 플라스크 — 웹 애플리케이션을 만들기 위한 간단하고 사용하기 쉬운 프레임워크
• 플라스크-휴식 최소한의 구성으로 REST API를 빠르게 개발할 수 있는 Flask의 확장입니다.

설치는 다음 명령으로 수행됩니다.

pip install flask-restful

초보자를 위한 무료 집중 프로그래밍을 권장합니다.
C#에서 텔레그램 봇 개발 — 26월 28~XNUMX일. 도우미 봇의 작동 방식, Telegram API 작업 기능 및 기타 뉘앙스를 이해할 수 있는 무료 집중 프로그램입니다. 상위 30명의 참가자는 Skillbox에서 000루블을 받게 됩니다..

시작하기 전에

우리는 기본으로 RESTful API를 개발할 것입니다. CRUID 기능.

작업을 완전히 이해하기 위해 위에서 언급한 두 용어를 이해합시다.

REST 란 무엇입니까?

REST API(Representational State Transfer)는 HTTP 요청을 사용하여 데이터를 교환하는 API입니다.

REST API는 특정 기준을 충족해야 합니다.

• 클라이언트-서버 아키텍처: 클라이언트는 사용자 인터페이스와 상호 작용하고 서버는 백엔드 및 데이터 저장소와 상호 작용합니다. 클라이언트와 서버는 독립적이며 둘 중 하나를 서로 별도로 교체할 수 있습니다.
• 상태 비저장 - 클라이언트 데이터가 서버에 저장되지 않습니다. 세션 상태는 클라이언트 측에 저장됩니다.
• 캐시 가능성 - 클라이언트는 전반적인 성능을 향상시키기 위해 서버 응답을 캐시할 수 있습니다.

CRUD란?

크루드 네 가지 기본 작업(만들기, 읽기, 업데이트 및 삭제)을 설명하는 프로그래밍 개념입니다.

REST API에서 요청 유형 및 요청 메서드는 게시, 가져오기, 넣기, 삭제와 같은 작업을 담당합니다.

이제 기본 용어를 다루었으므로 API 생성을 시작할 수 있습니다.

Разработка

인공 지능에 대한 인용문 저장소를 만들어 봅시다. AI는 오늘날 가장 빠르게 성장하는 기술 중 하나이며 Python은 AI 작업에 널리 사용되는 도구입니다.

이 API를 통해 Python 개발자는 AI에 대해 빠르게 배우고 새로운 성과에서 영감을 얻을 수 있습니다. 개발자가 이 주제에 대해 가치 있는 생각을 가지고 있다면 저장소에 추가할 수 있습니다.

필요한 모듈을 가져오고 Flask를 설정하여 시작하겠습니다.

from flask import Flask
from flask_restful import Api, Resource, reqparse
import random
app = Flask(__name__)
api = Api(app)

이 스니펫에서 Flask, Api 및 Resource는 필요한 클래스입니다.

Reqparse는 Flask-RESTful 요청 구문 분석 인터페이스입니다... 임의 인용을 표시하려면 random 모듈도 필요합니다.

이제 우리는 AI에 대한 인용문 저장소를 만들 것입니다.

각 저장소 항목에는 다음이 포함됩니다.

• 디지털 ID;
• 인용문 작성자의 이름;
• 인용하다.

이것은 학습 예제일 뿐이므로 모든 항목을 Python 목록에 저장합니다. 실제 애플리케이션에서는 대신 데이터베이스를 사용할 가능성이 높습니다.

ai_quotes = [
    {
        "id": 0,
        "author": "Kevin Kelly",
        "quote": "The business plans of the next 10,000 startups are easy to forecast: " +
                 "Take X and add AI."
    },
    {
        "id": 1,
        "author": "Stephen Hawking",
        "quote": "The development of full artificial intelligence could " +
                 "spell the end of the human race… " +
                 "It would take off on its own, and re-design " +
                 "itself at an ever increasing rate. " +
                 "Humans, who are limited by slow biological evolution, " +
                 "couldn't compete, and would be superseded."
    },
    {
        "id": 2,
        "author": "Claude Shannon",
        "quote": "I visualize a time when we will be to robots what " +
                 "dogs are to humans, " +
                 "and I’m rooting for the machines."
    },
    {
        "id": 3,
        "author": "Elon Musk",
        "quote": "The pace of progress in artificial intelligence " +
                 "(I’m not referring to narrow AI) " +
                 "is incredibly fast. Unless you have direct " +
                 "exposure to groups like Deepmind, " +
                 "you have no idea how fast — it is growing " +
                 "at a pace close to exponential. " +
                 "The risk of something seriously dangerous " +
                 "happening is in the five-year timeframe." +
                 "10 years at most."
    },
    {
        "id": 4,
        "author": "Geoffrey Hinton",
        "quote": "I have always been convinced that the only way " +
                 "to get artificial intelligence to work " +
                 "is to do the computation in a way similar to the human brain. " +
                 "That is the goal I have been pursuing. We are making progress, " +
                 "though we still have lots to learn about " +
                 "how the brain actually works."
    },
    {
        "id": 5,
        "author": "Pedro Domingos",
        "quote": "People worry that computers will " +
                 "get too smart and take over the world, " +
                 "but the real problem is that they're too stupid " +
                 "and they've already taken over the world."
    },
    {
        "id": 6,
        "author": "Alan Turing",
        "quote": "It seems probable that once the machine thinking " +
                 "method had started, it would not take long " +
                 "to outstrip our feeble powers… " +
                 "They would be able to converse " +
                 "with each other to sharpen their wits. " +
                 "At some stage therefore, we should " +
                 "have to expect the machines to take control."
    },
    {
        "id": 7,
        "author": "Ray Kurzweil",
        "quote": "Artificial intelligence will reach " +
                 "human levels by around 2029. " +
                 "Follow that out further to, say, 2045, " +
                 "we will have multiplied the intelligence, " +
                 "the human biological machine intelligence " +
                 "of our civilization a billion-fold."
    },
    {
        "id": 8,
        "author": "Sebastian Thrun",
        "quote": "Nobody phrases it this way, but I think " +
                 "that artificial intelligence " +
                 "is almost a humanities discipline. It's really an attempt " +
                 "to understand human intelligence and human cognition."
    },
    {
        "id": 9,
        "author": "Andrew Ng",
        "quote": "We're making this analogy that AI is the new electricity." +
                 "Electricity transformed industries: agriculture, " +
                 "transportation, communication, manufacturing."
    }
]

이제 API 끝점의 작업을 정의할 Quote 리소스 클래스를 만들어야 합니다. 클래스 내에서 get, post, put, delete의 네 가지 메서드를 선언해야 합니다.

GET 메서드부터 시작하겠습니다.

ID를 지정하여 특정 견적을 얻거나 ID가 지정되지 않은 경우 임의의 견적을 얻을 수 있습니다.

class Quote(Resource):
    def get(self, id=0):
        if id == 0:
            return random.choice(ai_quotes), 200
        for quote in ai_quotes:
            if(quote["id"] == id):
                return quote, 200
        return "Quote not found", 404

GET 메서드는 ID에 기본값이 포함된 경우 임의의 인용 부호를 반환합니다. 메서드 호출 시 ID가 설정되지 않았습니다.

설정된 경우 메서드는 따옴표 중에서 검색하고 주어진 ID를 포함하는 따옴표를 찾습니다. 아무것도 발견되지 않으면 "Quote not found, 404" 메시지가 표시됩니다.

이 메서드는 요청이 성공하면 HTTP 상태 200을 반환하고 항목을 찾을 수 없으면 404를 반환합니다.

이제 리포지토리에 새 견적을 추가하는 POST 메서드를 만들어 보겠습니다.

입력할 때 각각의 새 견적의 ID를 가져옵니다. 또한 POST는 reqparse를 사용하여 요청 본문(저자 및 인용 텍스트)에 들어갈 매개변수를 구문 분석합니다.

def post(self, id):
      parser = reqparse.RequestParser()
      parser.add_argument("author")
      parser.add_argument("quote")
      params = parser.parse_args()
      for quote in ai_quotes:
          if(id == quote["id"]):
              return f"Quote with id {id} already exists", 400
      quote = {
          "id": int(id),
          "author": params["author"],
          "quote": params["quote"]
      }
      ai_quotes.append(quote)
      return quote, 201

위의 코드에서 POST 메서드는 견적 ID를 허용했습니다. 그런 다음 reqparse를 사용하여 요청에서 작성자와 인용문을 검색하여 params 사전에 저장합니다.

지정된 ID가 있는 견적이 이미 있는 경우 메서드는 적절한 메시지와 코드 400을 표시합니다.

지정된 ID를 가진 인용문이 아직 생성되지 않은 경우 이 메서드는 지정된 ID와 작성자 및 기타 매개변수를 사용하여 새 항목을 생성합니다. 그런 다음 ai_quotes 목록에 항목을 추가하고 201 코드와 함께 새 견적이 포함된 항목을 반환합니다.

이제 리포지토리의 기존 견적을 변경하는 PUT 메서드를 만듭니다.

def put(self, id):
      parser = reqparse.RequestParser()
      parser.add_argument("author")
      parser.add_argument("quote")
      params = parser.parse_args()
      for quote in ai_quotes:
          if(id == quote["id"]):
              quote["author"] = params["author"]
              quote["quote"] = params["quote"]
              return quote, 200
      
      quote = {
          "id": id,
          "author": params["author"],
          "quote": params["quote"]
      }
      
      ai_quotes.append(quote)
      return quote, 201

이전 예제와 유사한 PUT 메서드는 ID와 입력을 사용하고 reqparse를 사용하여 견적 매개변수를 구문 분석합니다.

지정된 ID의 견적이 있는 경우 메서드는 새 매개변수로 이를 업데이트한 다음 코드 200으로 업데이트된 견적을 출력합니다. 지정된 ID의 견적이 아직 없으면 코드 201의 새 레코드가 생성됩니다.

마지막으로 더 이상 영감을 주지 않는 인용문을 제거하는 DELETE 메서드를 만들어 보겠습니다.

def delete(self, id):
      global ai_quotes
      ai_quotes = [qoute for qoute in ai_quotes if qoute["id"] != id]
      return f"Quote with id {id} is deleted.", 200

이 메서드는 견적의 ID를 입력으로 사용하고 공유 목록을 사용하여 ai_quotes 목록을 업데이트합니다.

이제 모든 메서드를 생성했으므로 API에 리소스를 추가하고 경로를 설정한 다음 Flask를 실행하기만 하면 됩니다.

api.add_resource(Quote, "/ai-quotes", "/ai-quotes/", "/ai-quotes/<int:id>")
if __name__ == '__main__':
    app.run(debug=True)

REST API 서비스가 준비되었습니다!

다음으로 콘솔에서 다음 명령을 실행하여 app.py 파일에 코드를 저장할 수 있습니다.

python3 app.py

모든 것이 정상이면 다음과 같은 결과가 나타납니다.

* 디버그 모드: 켜짐
* 실행 중 127.0.0.1:5000/ (Ctrl+C를 눌러 종료)
* 통계로 다시 시작
* 디버거가 활성화되었습니다!
* 디버거 PIN: XXXXXXX

API 테스트

API가 생성되면 테스트를 거쳐야 합니다.

이는 curl 콘솔 유틸리티 또는 Insomnia REST 클라이언트를 사용하거나 Rapid API에 API를 게시하여 수행할 수 있습니다.

API 게시

RapidAPI는 10개 이상의 API(및 약 000만 명의 개발자)가 있는 세계 최대의 마켓플레이스입니다.

RapidAPI는 타사 API 작업을 위한 단일 인터페이스를 제공할 뿐만 아니라 자신의 API를 빠르고 쉽게 게시할 수 있도록 합니다.

에 해, 먼저 네트워크의 일부 서버에 게시해야 합니다. 우리의 경우에는 다음을 사용할 것입니다. 헤로 꾸. 그와 함께 일하는 것은 어떤 어려움도 일으키지 않아야 합니다.여기에서 자세히 알아볼 수 있습니다.).

Heroku에 API를 게시하는 방법

1. 헤로쿠를 설치합니다.

첫 번째 단계는 Heroku 명령줄 인터페이스(CLI)를 등록하고 설치하는 것입니다. 이것은 우분투 16+에서 작동합니다.

sudo 스냅 설치 heroku --classic

그런 다음 로그인합니다.

헤 로쿠 로그인

2. 필요한 파일을 추가합니다.

이제 애플리케이션의 폴더에 게시할 파일을 추가해야 합니다.

• 필수 Python 모듈 목록이 있는 requirements.txt;
• 응용 프로그램을 실행하기 위해 실행해야 하는 명령을 지정하는 Procfile;
• .gitignore - 서버에 필요하지 않은 파일을 제외합니다.

requirements.txt 파일에는 다음 줄이 포함됩니다.

• 플라스크
• 플라스크 안정
• 총각

서버에서 응용 프로그램을 실행해야 하므로 gunicorn(Python WSGI HTTP Server)을 목록에 추가했습니다.

프로필 파일에는 다음이 포함됩니다.

웹 : gunicorn 앱 : 앱

.gitignore의 내용:

*.pyc
__pycache__/

이제 파일이 생성되었으므로 git repo를 초기화하고 커밋하겠습니다.

git init
git add
git commit -m "First API commit"

3. 새 Heroku 앱을 만듭니다.

heroku create

마스터 브랜치를 원격 Heroku 저장소로 푸시:

git push heroku master

이제 다음 명령으로 API 서비스를 열어 시작할 수 있습니다.

heroku ps:scale web=1
heroku open
 

API는 다음에서 사용할 수 있습니다. your-random-heroku-name.herokuapp.com/ai-quotes.

RapidAPI 마켓플레이스에 Python API를 추가하는 방법

API 서비스가 Heroku에 게시되면 Rapid API에 추가할 수 있습니다. 여기 자세한 문서 이 주제에.

1. RapidAPI 계정을 생성합니다.

무료 계정을 등록합니다. Facebook, Google, GitHub를 사용하여 등록할 수 있습니다.

2. 제어판에 API를 추가합니다.

3. 다음으로 API에 대한 일반 정보를 입력합니다.

4. "API 추가"를 클릭하면 API에 대한 정보를 입력할 수 있는 새 페이지가 나타납니다.

5. 이제 API 엔드포인트를 수동으로 입력하거나 다운로드할 수 있습니다. 스웨거 파일 OpenAPI를 사용합니다.

이제 엔드포인트 페이지에서 API의 엔드포인트를 설정해야 합니다. 우리의 경우 엔드포인트는 CRUD(get, post, put, delete)의 개념에 해당합니다.

다음으로 임의 견적(ID가 기본값인 경우) 또는 지정된 ID에 대한 견적을 표시하는 GET AI Quote 엔드포인트를 생성해야 합니다.

엔드포인트를 생성하려면 “엔드포인트 생성” 버튼을 클릭해야 합니다.

다른 모든 API 엔드포인트에 대해 이 프로세스를 반복합니다. 그게 다야! 축하합니다. API를 게시했습니다!

모든 것이 순조롭게 진행되면 API 페이지는 다음과 같이 표시됩니다.

결론

이 기사에서는 API를 Heroku 클라우드에 게시하고 이를 RapidAPI 디렉토리에 추가하는 프로세스와 함께 Python에서 자체 RESTful API 서비스를 생성하는 프로세스를 살펴보았습니다.

그러나 테스트 버전에서는 API 개발의 기본 원칙만 표시되었습니다. 보안, 내결함성 및 확장성과 같은 뉘앙스는 고려되지 않았습니다.

실제 API를 개발할 때 이 모든 것을 고려해야 합니다.

출처 : habr.com