집 >웹 프론트엔드 >JS 튜토리얼 >API 인터페이스를 만드는 방법은 무엇입니까?

API 인터페이스를 만드는 방법은 무엇입니까?

Linda Hamilton원래의: 2024-12-09 12:28:15380검색

How to make an API interface?

API는 애플리케이션 프로그래밍 인터페이스로, 다양한 소프트웨어 시스템과 통신하기 위한 채널로 이해될 수 있습니다. 본질적으로 사전 정의된 기능입니다.

API에는 다양한 형태가 있는데, 가장 널리 사용되는 형태는 HTTP 프로토콜을 사용하여 서비스(예: RESTful)를 제공하는 것이며, 규정을 충족하는 한 정상적으로 사용할 수 있습니다. 요즘에는 많은 기업에서 제3자가 제공하는 API를 사용하고, 제3자를 위한 API도 제공하므로 API 설계에도 주의가 필요합니다.

좋은 API 인터페이스를 디자인하는 방법은 무엇입니까?

기능 명시
설계 초기에는 비즈니스 기능 포인트나 모듈에 따라 API 기능을 구성하여 API에서 제공해야 하는 사항을 명확히 해야 합니다.
명확한 코드 로직
코드를 깔끔하게 유지하고 필요한 주석을 추가하여 인터페이스에 단일 기능이 있는지 확인하세요. 인터페이스에 복잡한 비즈니스 로직이 필요한 경우 인터페이스에 코드가 너무 많아 유지 관리 및 이후 반복에 도움이 되지 않도록 여러 인터페이스로 분할하거나 함수를 공개 메서드로 독립적으로 캡슐화하는 것이 좋습니다.
필수 보안 체크섬
일반적인 해결책은 디지털 서명을 사용하는 것입니다. 각 HTTP 요청에 서명을 추가하면 서버 측에서 서명의 유효성을 확인하여 요청의 신뢰성을 보장합니다.
로깅
문제를 적시에 파악하려면 로깅이 필수적입니다.
결합 최소화
좋은 API는 가능한 한 단순해야 합니다. API 간의 비즈니스 결합도가 너무 높으면 특정 코드에서 예외가 발생하여 해당 API를 사용할 수 없게 되기 쉽습니다. 따라서 API 간 관계의 복잡성은 최대한 피하는 것이 좋습니다.
의미 있는 상태 코드 반환
상태 코드 데이터는 API 반환 데이터에 포함되어야 합니다. 예를 들어 200은 요청이 정상임을 의미하고, 500은 서버에 내부 오류가 있음을 의미합니다. 공통 상태 코드를 반환하는 것은 문제 현지화에 좋습니다.
개발 문서
API는 타사 또는 내부용으로 제공되므로 개발 문서가 필수적입니다. 그렇지 않으면 다른 사람이 어떻게 사용하는지 알 수 없습니다.

좋은 API 개발 문서에는 다음 요소가 포함되어야 합니다.

API 아키텍처 모델 설명, 개발 도구 및 버전, 시스템 종속성 및 기타 환경 정보
API에서 제공하는 기능
API 모듈 종속성.
호출 규칙, 참고 사항
배치 노트 등

API 인터페이스를 어떻게 개발하나요?

개발 환경에 만족한다면 아마도 10분 이내에 간단한 API 인터페이스 개발을 완료할 수 있습니다(데모만 해당).

개발 전 JDK, Maven, IDE를 설치해야 합니다.

Spring Boot를 기반으로 새 프로젝트를 생성합니다. 빠르게 완료하기 위해 (start.spring.io)를 사용하여 프로젝트를 생성하기로 선택했습니다. [추가할 종속성 검색]을 통해 패키지를 선택할 수 있습니다. 저는 Spring MVC만 가져왔습니다. Mybatis를 통해 데이터베이스에 액세스해야 하는 경우 여기를 선택한 다음 클릭하여 프로젝트를 생성할 수도 있습니다.
다운로드한 프로젝트의 압축을 풀고 IDE에 삽입한 다음 새 클래스를 만듭니다: com.wukong.apidemo.controller.ApiController.
이 클래스에 @RestController, @RequestMapping, @ResponseBody 태그를 주로 사용하는 메서드를 추가합니다.
가장 간단한 API 인터페이스가 완성되었습니다. 프로젝트를 시작하고 해당 인터페이스 주소에 접근하여 인터페이스 반환 정보를 얻을 수 있습니다.
Swagger를 사용하면 인터페이스 문서를 생성하고 API 인터페이스를 최적화할 수 있습니다.

API 인터페이스를 만드는 더 효율적인 방법은 무엇인가요?

Python Flask와 Java Spring Boot를 모두 사용하여 API 인터페이스를 효율적으로 생성할 수 있습니다.

Spring Boot는 개발 프로세스를 단순하게 단순화했습니다. Python의 경우 API 인터페이스 개발을 위한 타사 패키지인 fastapi를 권장합니다.

다음 기능을 갖춘 빠르고 효율적인 도구입니다.

빠름: NodeJS 및 Go와 비슷합니다. 가장 빠른 Python 프레임워크 중 하나입니다.
빠른 코딩: 개발 속도를 약 200%~300% 높입니다.
오류 감소: 개발자에 의한 오류가 약 40% 감소합니다.
간단함: 사용 및 학습이 쉽습니다. 문서를 읽는 데 소요되는 시간이 줄어듭니다.
표준 기반: API의 개방형 표준을 기반으로 하며 완벽하게 호환됩니다.

Python3 및 Flask를 사용하여 RESTful API 만들기(인터페이스 테스트 서비스 및 모의 서버 도구)

RESTful API 구축은 개발자의 작업인 것처럼 보이지만 실제로 테스트 개발자가 RESTful API를 구축해야 하는 시나리오는 많습니다.

일부 테스터는 RESTful API를 구축하고, 서버 측 도메인 이름을 자신의 API로 하이재킹하고, 클라이언트의 안정성을 확인하기 위해 의도적으로 모든 종류의 예외를 반환합니다.

REST： REpresentational State Transfer
GET - /api/Category - Retrieve all categories
POST - /api/Category - Add a new category
PUT - /api/Category - Update a category
DELETE - /api/Category - Delete a category
GET - /api/Comment - Retrieve all the stored comments
POST - /api/Comment - Add new comment

요구 사항:python3.*,PostgreSQL.

REST： REpresentational State Transfer
GET - /api/Category - Retrieve all categories
POST - /api/Category - Add a new category
PUT - /api/Category - Update a category
DELETE - /api/Category - Delete a category
GET - /api/Comment - Retrieve all the stored comments
POST - /api/Comment - Add new comment

Requirements.txt는 다음과 같습니다.
Flask - Python용 마이크로프레임워크
Flask_restful - REST API를 빠르게 구축하기 위한 플라스크의 확장입니다.
Flask_script - 플라스크에서 외부 스크립트 작성을 지원합니다.
Flask_ migration - SQLAlchemy 데이터베이스 마이그레이션을 위해 Alembic의 Flask 앱을 사용합니다.
Marshmallow - 복잡한 데이터 유형 및 Python 데이터 유형 변환용.
Flask_sqlalchemy - SQLAlchemy에 대한 지원을 추가하는 플라스크 확장입니다.
Flask_marshmallow - 플라스크와 마시멜로 사이의 중간층.
Marshmallow-sqlalchemy - sqlalchemy와 marshmallow 사이의 중간 계층입니다.
psycopg - Python용 PostgreSQL API.

종속성 설치

project/
├── app.py
├── config.py
├── migrate.py
├── Model.py
├── requirements.txt
├── resources
│   └── Hello.py
│   └── Comment.py
│   └── Category.py
└── run.py

PostgreSQL 설치 및 구성(Ubuntu 16.04를 예로 들어)

# pip3 install -r requirements.txt

구성

# sudo apt-get update && sudo apt-get upgrade
# apt-get install postgresql postgresql-contrib
# su - postgres
$ createdb api
$ createuser andrew --pwprompt #Create User
$ psql -d api -c "ALTER USER andrew WITH PASSWORD 'api';"

빠른 시작

app.py

from flask import Blueprint
from flask_restful import Api
from resources.Hello import Hello
from resources.Category import CategoryResource
from resources.Comment import CommentResource


api_bp = Blueprint('api', __name__)
api = Api(api_bp)

# Routes
api.add_resource(Hello, '/Hello')
api.add_resource(CategoryResource, '/Category')
api.add_resource(CommentResource, '/Comment')

리소스/Hello.py

from flask import Blueprint
from flask_restful import Api
from resources.Hello import Hello

api_bp = Blueprint('api', __name__)
api = Api(api_bp)

# Route
api.add_resource(Hello, '/Hello')

run.py

#!/usr/bin/python
# -*- coding: utf-8 -*-
# Author:    xurongzhong#126.com wechat:pythontesting qq:37391319
# CreateDate: 2018-1-10

from flask_restful import Resource


class Hello(Resource):
    def get(self):
        return {"message": "Hello, World!"}

    def post(self):
        return {"message": "Hello, World!"}

서비스 시작

from flask import Flask


def create_app(config_filename):
    app = Flask(__name__)
    app.config.from_object(config_filename)

    from app import api_bp
    app.register_blueprint(api_bp, url_prefix='/api')

    return app


if __name__ == "__main__":
    app = create_app("config")
    app.run(debug=True)

브라우저를 사용하여 http://127.0.0.1:5000/api/Hello를 방문하세요

$ python3 run.py
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
 * Restarting with stat
 * Debugger is active!
 * Debugger PIN: 136-695-873

데이터베이스 액세스

{
    "hello": "world"
}

migration.py

from flask import Flask
from marshmallow import Schema, fields, pre_load, validate
from flask_marshmallow import Marshmallow
from flask_sqlalchemy import SQLAlchemy


ma = Marshmallow()
db = SQLAlchemy()


class Comment(db.Model):
    __tablename__ = 'comments'
    id = db.Column(db.Integer, primary_key=True)
    comment = db.Column(db.String(250), nullable=False)
    creation_date = db.Column(db.TIMESTAMP, server_default=db.func.current_timestamp(), nullable=False)
    category_id = db.Column(db.Integer, db.ForeignKey('categories.id', ondelete='CASCADE'), nullable=False)
    category = db.relationship('Category', backref=db.backref('comments', lazy='dynamic' ))

    def __init__(self, comment, category_id):
        self.comment = comment
        self.category_id = category_id


class Category(db.Model):
    __tablename__ = 'categories'
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(150), unique=True, nullable=False)

    def __init__(self, name):
        self.name = name


class CategorySchema(ma.Schema):
    id = fields.Integer()
    name = fields.String(required=True)


class CommentSchema(ma.Schema):
    id = fields.Integer(dump_only=True)
    category_id = fields.Integer(required=True)
    comment = fields.String(required=True, validate=validate.Length(1))
    creation_date = fields.DateTime()

데이터 마이그레이션

from flask_script import Manager
from flask_migrate import Migrate, MigrateCommand
from Model import db
from run import create_app

app = create_app('config')

migrate = Migrate(app, db)
manager = Manager(app)
manager.add_command('db', MigrateCommand)


if __name__ == '__main__':
    manager.run()

테스트
예를 들어 다음과 같이 컬을 사용할 수 있습니다.

$ python3 migrate.py db init
$ python3 migrate.py db migrate
$ python migrate.py db upgrade

위 내용은 API 인터페이스를 만드는 방법은 무엇입니까?의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

성명：

이전 기사：경로 연결을 위해 JavaScript 정규식에서 백슬래시를 올바르게 처리하려면 어떻게 해야 합니까?다음 기사：경로 연결을 위해 JavaScript 정규식에서 백슬래시를 올바르게 처리하려면 어떻게 해야 합니까?