自动生成接口文档

自动生成接口文档

• 后端人员写好接口，编写接口文档，给前端，前端依照接口文档开发
• 公司主流
  • 使用world、md写，提交到git上
  • 公司有接口平台，后端开发在接口平台录入（yapi，第三方），可以批量导入
  • 后端项目自动生成接口文档，（有时需要配合上面两种）
    • Django的drf自动生成：coreapi
    • swagger：Java，go，python

coreapi自动生成

# 第一步：安装：pip install coreapi
# 第二步：路由中配置
from rest_framework.documentation import include_docs_urls
urlpatterns = [
    path('docs/', include_docs_urls(title='路飞项目接口文档')),]


# 第三步：配置文件中配置
REST_FRAMEWORK = {
    ## 接口文档配置
    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
}

#第四步：写接口，加注释

# 第五步：访问
http://127.0.0.1:8000/docs/
        
# 说明： 视图中的retrieve接口在接口网站中交read；接口网站中的参数Description需要在模型类或序列化器类中加help_text参数来自定义
class Student(models.Model):
    age = models.IntegerField('年龄', default=0,help_text='年龄')


class StudentSerializer(serializers.ModelSerializer):
    class Meta:
        model = Student
        fields = "__all__"
        extra_kwargs = {
            'age': {
                'required': True,
                'help_text': '年龄'
            }
        }