laravel-api-docs-generate自定義生成API文檔模板

defcon 發布于2019-06-27 15:39 / 3062人閱讀

摘要：關于作者程序開發人員，不拘泥于語言與技術，目前主要從事和前端開發，使用和，端使用混合式開發。合適和夠用是最完美的追求。個人網站最近剛寫了一個手機在線播放的電影站驗證失敗參數類型是否必填中文名驗證規則安小下同學

關于作者

程序開發人員，不拘泥于語言與技術，目前主要從事PHP和前端開發，使用Laravel和VueJs，App端使用Apicloud混合式開發。合適和夠用是最完美的追求。

個人網站：http://www.linganmin.cn

最近剛寫了一個手機在線播放的H5電影站：http://www.ifilm.ltd


@if($parsedRoute["title"] != "")## {{ $parsedRoute["title"]}}
@else## {{$parsedRoute["uri"]}}
@endif
@if($parsedRoute["description"])

{!! $parsedRoute["description"] !!}
@endif

// apicloud
var that = this;
app.{{strtolower($parsedRoute"methods")}}("{{strtr($parsedRoute["uri"], ["api/" => ""])}}", @if(count($parsedRoute["parameters"])){!! str_replace(" "," ",json_encode(array_combine(array_keys($parsedRoute["parameters"]), array_map(function($param){ return $param["value"]; },$parsedRoute["parameters"])), JSON_PRETTY_PRINT)) !!}, @endif function (data) {

//todo render
that.data = data

}@if($parsedRoute"methods" == "POST"), function (xhr) {

switch (xhr.status) {
    case 422:
        //todo 驗證失敗
        //app.alert(xhr.responseJSON);
        break;
}

}@endif);

@if(in_array("GET",$parsedRoute["methods"]))
> Example response:

@if(is_object($parsedRoute["response"]) || is_array($parsedRoute["response"]))
{!! json_encode($parsedRoute["response"], JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE) !!}
@else
{!! json_encode(json_decode($parsedRoute["response"]), JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE) !!}
@endif

@endif

### HTTP Request
@foreach($parsedRoute["methods"] as $method)
`{{$method}} {{$parsedRoute["uri"]}}`

@endforeach
@if(count($parsedRoute["parameters"]))
#### Parameters

參數 | 類型 | 是否必填 | 中文名 | 驗證規則
--------- | ------- | ------- | ------- | ----------- | -----------
@foreach($parsedRoute["parameters"] as $attribute => $parameter)
    {{$attribute}} | {{$parameter["type"]}} | @if($parameter["required"]) required @else optional @endif | {{trans("validation.attributes." . $attribute)}} | {!! implode(" ",$parameter["description"]) !!}
@endforeach
@endif


> Example request:

curl "{{config("app.url")}}/{{$parsedRoute["uri"]}}"
-H "Accept: application/json"@if(count($parsedRoute["parameters"]))
@foreach($parsedRoute["parameters"] as $attribute => $parameter)

-d "{{$attribute}}"="{{$parameter["value"]}}"

@endforeach
@endif

安小下同學

GPU云服務器云服務器自定義通知生成API文檔文檔生成 python生成文檔

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/22469.html

優于 swagger 的 java markdown 文檔自動生成框架-01-入門使用

摘要：很多項目不寫文檔，即使寫文檔，對于開發人員來說也是非常痛苦的。無法保證及時更新。是基于注解的文檔生成工具。讓文檔的閱讀者享受到等同于手寫文檔的體驗。將信息的獲取和生成區分開。基于原生的注釋，盡可能的生成簡介的文檔。設計初衷節約時間 Java 文檔一直是一個大問題。很多項目不寫文檔，即使寫文檔，對于開發人員來說也是非常痛苦的。不寫文檔的缺點自不用多少，手動寫文檔的缺點也顯而易見：...

RdouTyping 2019-08-16 15:53 評論0 收藏0
MyBatis Generator 自定義生成注釋

摘要：最近做項目，使用的是，為了偷懶，我自然而然的想到了使用來生成數據庫表對應的實體代碼和代碼。最近做項目，ORM 使用的是 MyBatis，為了偷懶，我自然而然的想到了使用 MyBatis Generator（MBG）來生成數據庫表對應的實體代碼和 Mapper 代碼。于是做了如下的配置（對 MBG 配置不熟悉的同學可以參考 Mybatis Generator最完整配置詳解）： ...

sugarmo 2019-08-19 11:14 評論0 收藏0
registerModule: 動態注冊vuex模塊，對于自定義生成組件很有用

摘要：動態注冊模塊在創建之后，你可以使用方法注冊模塊動態注冊模塊，對于自定義生成組件很有用實現方案注冊前后中對比結尾源碼地址 registerModule: 動態注冊vuex模塊在 store 創建之后，你可以使用 store.registerModule 方法注冊模塊：registerModule 動態注冊vuex模塊，對于自定義生成組件很有用實現方案 html {{messag...

Kerr1Gan 2019-08-22 16:41 評論0 收藏0
Spring Data REST API集成Springfox、Swagger

摘要：請注意，截至目前版本，用于的集成仍處于孵化階段，并且存在一些嚴重的錯誤和缺少的功能例如，請參閱此處和此處。響應可以使用和注解來調整不同的響應狀態及其有效結論允許您在創建數據庫驅動的時產生快速結果。原文: Documenting a Spring Data REST API with Springfox and Swagger 使用Spring Date REST，你可以迅速為Spr...

darcrand 2019-08-15 14:44 評論0 收藏0
在Forge Viewer上顯示自訂義屬性

摘要：最近有的小伙伴們都在詢問要怎么在里顯示自訂義屬性，要做到這個是挺容易的。在來我們透過繼承來創建自個的屬性面板使用的語法，部份代碼來自的無法從服務器獲取屬性透過撰寫括展讓自定義屬性窗取代自帶的以上希望對各為小伙伴有幫助參考最近有 Autodesk Forge 的小伙伴們都在詢問要怎么在 Viewer 里顯示自訂義屬性，要做到這個是挺容易的。目前有兩種方式可以做到這個效果，一種是直接添加...

seasonley 2019-08-21 17:12 評論0 收藏0