我的任务是为我们的Django代码库添加一个自动化的端点文档工具。它需要生成html文件，然后我们可以将其托管在我们的s3 bucket中以供内部参考。我原以为drf-spectacular会是它，但它似乎并没有真正产生html文件，而只是一个模式文件。有没有一个工具或库可以做到这一点？比如JSDocs或TypeDoc，在那里我可以运行一个命令，并将html文档文件转储到s3桶中。谢谢大家！
h9vpoimq1#
如果您想继续使用drf-spectacular，一个选择是使用其他工具将生成的模式文件转换为HTML文档。以下是如何做到这一点的步骤：1 -使用DRF-Spectacular生成模式文件，就像您通常所做的那样：
python manage.py spectacular --file schema.yml
2 -安装redoc-cli将schema文件转换为静态HTML文档：
npm install -g redoc-cli
3 -使用redoc-cli将schema文件转换为静态HTML文件：
redoc-cli bundle schema.yml -o documentation.html
此命令将生成一个documentation.html文件，其中包含基于您的架构的API文档，但您可以使用各种Redoc选项自定义生成的文档的外观和行为。4 -将生成的documentation.html文件上传到您的S3存储桶，使用AWS CLI将文件上传到S3存储桶：
aws s3 cp documentation.html s3://your-bucket-name/path/to/destination/
您需要安装AWS CLI并使用适当的凭据进行配置，才能执行此步骤。通过这种方式，您可以将DRF-Spectacular与Redoc结合起来，生成Django代码库所需的HTML文档，并将其托管在S3存储桶中。
1条答案
按热度按时间h9vpoimq1#
如果您想继续使用drf-spectacular，一个选择是使用其他工具将生成的模式文件转换为HTML文档。
以下是如何做到这一点的步骤：
1 -使用DRF-Spectacular生成模式文件，就像您通常所做的那样：
2 -安装redoc-cli将schema文件转换为静态HTML文档：
3 -使用redoc-cli将schema文件转换为静态HTML文件：
此命令将生成一个documentation.html文件，其中包含基于您的架构的API文档，但您可以使用各种Redoc选项自定义生成的文档的外观和行为。
4 -将生成的documentation.html文件上传到您的S3存储桶，使用AWS CLI将文件上传到S3存储桶：
您需要安装AWS CLI并使用适当的凭据进行配置，才能执行此步骤。
通过这种方式，您可以将DRF-Spectacular与Redoc结合起来，生成Django代码库所需的HTML文档，并将其托管在S3存储桶中。