有没有办法为我的 drf-yasg 端点提供自定义名称？

Question

i am implementing an API using django-rest-framework and using drf-yasg to document and name my endpoints every post method ends with create

i tried searching through the documentation and i cant find a way to do it

Answer 1

You can use tags to categorize your API endpoints in drf swagger (drf-yasg), you can use the '@swagger_auto_schema' decorator and specify the 'tags' parameter.

For example, if you have a view that lists all users in your system, you can use the @swagger_auto_schema decorator to specify the users tag like this:

@swagger_auto_schema(tags=['users'])
def list_users(request):
    # code to list users
    pass

This will cause the API endpoint for the list_users view to be displayed under the users tag in the generated documentation.

You can also specify tags for your models by using the tags field in the Meta class of your serializer. For example:

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = ['id', 'username', 'email']
        tags = ['users']

This will cause the UserSerializer to be displayed under the users tag in the generated documentation.

Answer 2

As someone mentioned in the comment, you should use the @swagger_auto_schema() decorator for your API in order to customize it. then set operation_id to change its name in swagger docs.

here is an exact example that'll solve your problem: drf-yasg: How to change operationId?