django-restframework-swagger 沒有model時 自定義參數(shù)框

django-restframework-swagger 2.1.2(2.2.0也可以,UI更好看些,但是不方便測試,所以我選擇2.1.2)

效果圖

image.png

參數(shù)框:


class S2ViewList(GenericAPIView):#

serializer_class = S2createSerializer #指定序列化類,自動顯示model body



schema = AutoSchema (

manual_fields=[

coreapi.Field (name='vxnet',required=False,location='query',description='',type='string'),

coreapi.Field (name='service_type',required=False,location='query',description='',

type='string'),

]

)

def get(self,request,format=None):

.....

def post(self, request,format=None):

.......

AutoSchema的參數(shù)對所有方法都一致,為了區(qū)分不同方法顯示不同參數(shù)爽室,參考AutoSchema源碼,繼承它寫一個新類:

class RecycleSchema (AutoSchema):
    """
    Overrides 'get_manual_fields()' to provide Custom Behavior X
    """
    
    def __init__(self, manual_fields=None, delete_fields=None):
        """
        Parameters:

        * `manual_fields`: list of `coreapi.Field` instances that
            will be added to auto-generated fields, overwriting on `Field.name`
        """
        super (RecycleSchema, self).__init__ (manual_fields)
        if manual_fields is None:
            manual_fields = []
        self._manual_fields = manual_fields
        if delete_fields is None:
            delete_fields = []
        self._delete_fields = delete_fields
    
    def get_manual_fields(self, path, method):
        """Example adding per-method fields."""
        
        delete_fields = []
        if method == 'DELETE':
            delete_fields = self._delete_fields
        
        manual_fields = super ().get_manual_fields (path, method)
        return manual_fields + delete_fields
    
    def get_delete_fields(self, path, method):
        return self._delete_fields

view中:

class InstancesList(APIView):
    """
    get:
        獲取回收站instances列表
    delete:
        徹底刪除instance
    """
    schema = RecycleSchema(
        manual_fields=[
            coreapi.Field(
                name='Authorization',
                required='True',
                location='header',
                description='Authentication header',
                type='string'),
            coreapi.Field(
                name='DcCode',
                required='True',
                location='header',
                description='dccode header')],
        delete_fields=[
            coreapi.Field(
                name='instances',
                required=True,
                location="query",
                description='主機id')])

若想實現(xiàn)response body也顯示model淆攻,考慮使用drf-yasg,其使用openapi阔墩,swagger界面更完善(復(fù)雜):
https://github.com/axnsan12/drf-yasg/tree/23ebba420734d9760d2e60d4c3b057d7accc8996#code-generation

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市瓶珊,隨后出現(xiàn)的幾起案子啸箫,更是在濱河造成了極大的恐慌,老刑警劉巖伞芹,帶你破解...
    沈念sama閱讀 218,451評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件忘苛,死亡現(xiàn)場離奇詭異,居然都是意外死亡唱较,警方通過查閱死者的電腦和手機扎唾,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,172評論 3 394
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來南缓,“玉大人胸遇,你說我怎么就攤上這事『盒危” “怎么了纸镊?”我有些...
    開封第一講書人閱讀 164,782評論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長概疆。 經(jīng)常有香客問我逗威,道長,這世上最難降的妖魔是什么岔冀? 我笑而不...
    開封第一講書人閱讀 58,709評論 1 294
  • 正文 為了忘掉前任凯旭,我火速辦了婚禮,結(jié)果婚禮上使套,老公的妹妹穿的比我還像新娘罐呼。我一直安慰自己,他們只是感情好童漩,可當(dāng)我...
    茶點故事閱讀 67,733評論 6 392
  • 文/花漫 我一把揭開白布弄贿。 她就那樣靜靜地躺著春锋,像睡著了一般矫膨。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,578評論 1 305
  • 那天侧馅,我揣著相機與錄音危尿,去河邊找鬼。 笑死馁痴,一個胖子當(dāng)著我的面吹牛谊娇,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播罗晕,決...
    沈念sama閱讀 40,320評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼济欢,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了小渊?” 一聲冷哼從身側(cè)響起法褥,我...
    開封第一講書人閱讀 39,241評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎酬屉,沒想到半個月后半等,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,686評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡呐萨,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,878評論 3 336
  • 正文 我和宋清朗相戀三年杀饵,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片谬擦。...
    茶點故事閱讀 39,992評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡切距,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出怯屉,到底是詐尸還是另有隱情蔚舀,我是刑警寧澤,帶...
    沈念sama閱讀 35,715評論 5 346
  • 正文 年R本政府宣布锨络,位于F島的核電站赌躺,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏羡儿。R本人自食惡果不足惜礼患,卻給世界環(huán)境...
    茶點故事閱讀 41,336評論 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望掠归。 院中可真熱鬧缅叠,春花似錦、人聲如沸虏冻。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,912評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽厨相。三九已至领曼,卻和暖如春鸥鹉,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背庶骄。 一陣腳步聲響...
    開封第一講書人閱讀 33,040評論 1 270
  • 我被黑心中介騙來泰國打工毁渗, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人单刁。 一個月前我還...
    沈念sama閱讀 48,173評論 3 370
  • 正文 我出身青樓灸异,卻偏偏與公主長得像,于是被迫代替她去往敵國和親羔飞。 傳聞我的和親對象是個殘疾皇子肺樟,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,947評論 2 355

推薦閱讀更多精彩內(nèi)容