flasgger/flasgger

How does flasgger handle multiple URLs with flask-restful?

Open

#174 aberto em 28 de dez. de 2017

Ver no GitHub
 (10 comments) (0 reactions) (0 assignees)Python (3.435 stars) (500 forks)batch import
bughacktoberfesthelp wanted

Description

I'm using flask-restful and have a resource with two URLs, like this:

    api.add_resource(Job, '/job/<int:job_id>', '/job')

where job_id is used only by the GET method.

In the resources code I have:

class Job(Resources):
    def get(self, job_id):
        """
        Retrieve a job from its ID
        ---
        tags:
          - Jobs
        parameters:
        - name: job_id
          in: path
          description: ID of the job
          required: true
        responses:
          200:
            description: Job found
          404:
            description: Job not found
        """

the expected result is a swagger spec with only one URL path for the GET operation, but flasgger generates a swwager spec with two URL paths for the GET one for /job/{job_id} and another one for /job.

Is it possible to separate specifications by path or method in this case?

Guia do colaborador

Pilha de tecnologia
pythonflask
Domain
apibackend
Tipo Issue
bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 hours
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
Basic knowledge of Flask and flask restfulUnderstanding of Swagger/OpenAPI specs
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
45
Direção de pesquisa
Investigate how flasgger generates Swagger specs from docstrings, focusing on the path registration logic. Look at the Swagger class in flasgger's base.py and how it processes endpoint rules from flask restful. Check if there is a way to associate different methods with different paths. Review comments in the issue for any proposed solutions or links to related PRs.