項目開發過程中需要注意的一些小細節

現在的項目大都是前後端分離的,後臺開發呢,我個人是用的Swagger-ui來作爲文檔管理,如何讓前端更友好的調試接口呢,

通常前端參數超過2個以上呢  我們都會對參數進行對象的封裝,有可能我們幾個接口都用了這個封裝的對象,有的不需要傳那麼多的參數,這樣我們如何通過Swagger指定我們所需參數呢,可以利用如下參數格式:

@ApiImplicitParams({
            @ApiImplicitParam(name = "eventTypeCode", value = "類型", dataType = "String", paramType = "query"),
            @ApiImplicitParam(name = "eventFirmCode", value = "來源", dataType = "String", paramType = "query"),
            @ApiImplicitParam(name = "eventLevelCode", value = "等級", dataType = "String", paramType = "query"),
            @ApiImplicitParam(name = "type", value = "事件歸屬分類,如:事件1、事件2", dataType = "String", paramType = "query"),
            @ApiImplicitParam(name = "search", value = "搜索框", dataType = "String", paramType = "query"),
            @ApiImplicitParam(name = "noticeStatus", value = "狀態 已通報 未通報", dataType = "String", paramType = "query"),
            @ApiImplicitParam(name = "eventStatus", value = "數據統計框:未處理 處理中 待複覈 已修復", dataType = "String", paramType = "query"),
    })
    public EventCount eventCount(@ApiIgnore Event event) {
        return eventService.eventCount(event);
    }

我們Event對象中有N多個參數也不會影響到Swagger中需傳參數,只會顯示列出來的這幾個參數。我們可以很友好的讓前端知道我們所需的參數,更好的提高我們項目的開發效率,更加容易維護。

還有就是我們在做一些流程處理時,避免讓前端傳入狀態修改流程走向,這樣可以有效的避免別人拿到我們的api進行惡意篡改,

等等還有挺多,有時間在分享~.~

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章