Início / coding / Perguntas / 79307475
Accepted
Konrad Viltersten
Asked: 2024-12-25 19:30:32 +0800 CST

Não é possível decidir entre invocação baseada em recurso ou rota

  • 772

Devido à imensa noobidade em relação ao Python em geral e ao Flask em particular, estou fundamentalmente confuso em relação às convenções, melhores práticas e know-how comum. Tento seguir os exemplos fornecidos pela Microsoft (já que estamos trabalhando com o Azure) e começo a suspeitar que eles podem ser... Microsoft'ish (ou seja, "funciona, mas...").

Com base em vários exemplos, criei dois endpoints, carregando a mesma computação, resultando em payloads equivalentes (não a mesma estrutura, no entanto!) e não consigo descobrir qual é a abordagem recomendada. Uma é usar recursos (junto com uma rota), enquanto a outra é roteamento explícito.

from flask import Flask
from flask_restful import Api, Resource, request
from logic import compute

app = Flask(__name__)
api = Api(app)

class computer (Resource):
    def get(self):
        return compute(request.args.to_dict())

api.add_resource(computer, "/compute-resource")

@app.route("/compute-route", methods=["GET"])
def execute():
    return compute(request.args.to_dict())

if __name__ == "__main__":
    app.run()

A única coisa (estranhamente inesperada) que notei na saída é que o último parece classificar os campos do JSON retornado em ordem alfabética, enquanto o primeiro não.

  1. Qual dessas duas abordagens é preferida ou são equivalentemente apropriadas?
  2. O que o desvio na ordenação dos campos sugere, se é que sugere alguma coisa?
python

1 respostas

  1. Best Answer

    Sua pergunta toca em um dilema comum ao projetar APIs Flask: se deve usar a abordagem baseada em Flask-RESTfulResource ou a abordagem baseada em rota do Flask . Ambas são válidas e têm seu lugar, dependendo do seu caso de uso e preferências.

    Principais diferenças

    1. Frasco-RESTful ( Resource):

      • Incentiva a programação orientada a objetos.
      • Adequado para APIs RESTful onde recursos (entidades como "usuários" ou "pedidos") são mapeados para pontos de extremidade de URL.
      • Organiza facilmente a lógica para diferentes métodos HTTP ( GET, POST, PUT, DELETE) usando métodos de classe.
      • Ordenação de campos : o Flask-RESTful não classifica chaves JSON por padrão, e é por isso que você observa campos não classificados.

      Exemplo:

      class UserResource(Resource):
    def get(self):
        return {"name": "Alice", "age": 25}  # Order preserved.

    2. Abordagem baseada em rotas ( @app.route):

      • Tradicional e mais simples de entender para iniciantes em Flask.
      • Ideal para pequenos aplicativos ou APIs não RESTful onde os endpoints são procedimentais ou únicos.
      • Ordenação de campos : A jsonifyfunção (implicitamente usada pelo Flask @app.route) classifica as chaves em ordem alfabética por padrão ao serializar para JSON.

      Exemplo:

      @app.route("/user")
def user():
    return {"age": 25, "name": "Alice"}  # Alphabetically sorted as {"age": 25, "name": "Alice"}.

    Melhores Práticas

    1. Quando usar Flask-RESTful:

      • Seu aplicativo requer princípios de design RESTful.
      • Você tem vários recursos e endpoints que precisam de organização.
      • Você planeja expandir a API ou trabalhar em equipe, e uma abordagem baseada em classes ajuda na legibilidade e na manutenção.

    2. Quando usar baseado em rota:

      • O aplicativo é pequeno e adicionar Flask-RESTful é exagero.
      • Os endpoints são limitados em número e não exigem organização complexa.
      • Você prefere simplicidade à abstração adicional fornecida pelo Flask-RESTful.

    Seu Caso

    Como ambos os métodos levam ao mesmo resultado e a única diferença é a ordem dos campos:

    1. Se você estiver criando uma API RESTful (por exemplo, para integração com o Azure ou projetos maiores), use o Flask-RESTful por sua estrutura e escalabilidade.
    2. Se for um pequeno utilitário ou um ponto de extremidade único, a abordagem baseada em rotas é perfeitamente adequada.

    Sobre a ordenação de campos

    O desvio na ordenação dos campos é devido a:

    • O Flask-RESTful usa jsona biblioteca do Python diretamente, o que preserva a ordem de inserção dos dicionários.
    • A abordagem baseada em rota usa o Flask's jsonify, que é aplicado sort_keys=Truepor padrão ao despejar JSON.

    Se você quiser controlar a ordenação dos campos na abordagem baseada em rotas, você pode desabilitar a classificação desta forma:

    from flask import jsonify

@app.route("/compute-route", methods=["GET"])
def execute():
    return jsonify(compute(request.args.to_dict())), 200, {"Content-Type": "application/json"}

    Recomendação

    Para manutenibilidade e escalabilidade, especialmente ao trabalhar com Azure ou plataformas similares, adote Flask-RESTful comResource . Ele se alinha com os padrões da REST API e mantém seu código organizado conforme o projeto cresce.

    • 1

relate perguntas