def test_tips(self): doc = Doc() api = Api(title='test api', url='/test/', method='DELETE') api.tips = '## Be careful to destroy' doc.add_api(api) html = doc.build() self.assertIn('<div class="endpoint delete">', html) self.assertIn('<h2>Be careful to destroy</h2>', html)
<script> const ui = SwaggerUIBundle({{ url: "{{% url schema_url %}}", dom_id: '#swagger-ui', presets: [ SwaggerUIBundle.presets.apis, SwaggerUIBundle.SwaggerUIStandalonePreset ], layout: "BaseLayout" }}) </script> </body> </html> ``` """ api.tips = f""" #### 众多著名的框架都直接或间接的支持 Swagger 插件 1. Java 领域,著名的 `spring-swagger`,后更名为 `springfox` 2. django-rest-framework 搭配 `drf_yasg` 或 `coreapi` 3. `FastAPI` 更是完美的原生支持,可一键生成 swagger 风格文档 4. ... ##### **解决痛点:** 随着时间推移,不断修改接口实现的时候都必须同步修改接口文档,而文档与代码又处于两个不同的媒介,除非有严格的管理机制,不然很容易导致不一致现象。 """ doc.add_api(api) api = Api(method='PUT') api.title = 'Django REST framework' api.url = '/3.9 版本开始/官方逐步加强对 openapi3 的支持' api.description = f"""