問題タブ [django-swagger]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
django - 関数ベースのビュー パラメータを文書化する方法は?
Django 1.11 と Django REST Framework 3.7 を使用して REST API を開発しています。ドキュメントを生成するためにDjango REST Swagger 2.1をインストールしました。
次のような関数ベースのビューを使用しています。
ご覧のとおり、私のビューは Swagger によって認識され、" View description here " という正しい説明が表示されます。
でも:
- URL パラメータの [説明] 列が空になっていることがわかります。
provider
- POST パラメーターは文書化されていません (明らかに、Swagger がそれらを知る方法がないため)
関数ベースのビューの URL と POST パラメーター、および応答に関するドキュメントを作成するにはどうすればよいですか?
YAML Docstringsを試してみましたが、古いバージョン (0.3.x) 用のようで、バージョン 2.x では動作しません。