對工程師來說,coding 不完全是我們工作的全部,有的時候我們花了更多時間在會議討論、溝通、交付文件。雖然溫憨慢共話,不過文件會說話,生出好文件,做事好方便

Doc Us

於是我們做了這套 Laravel 的 MySQL database schema 文件生成工具,跟著下面的「三三三」,支援三種輸出、安裝三步驟、演示三種結果,帶你來了解這套工具

支援三種輸出

滿足郎客的不同需求,像是 PM 想在瀏覽器閱讀 schema 文件、開發者喜歡看 Markdown 格式,還有可供程式串接的 JSON 格式,這一切都在彈指之間。

supported-format:

  • html
  • markdown
  • json

依照下方步驟安裝完畢,即可簡單使用

1
2
3
4
# 安裝三步驟
1. composer 一道指令安裝

composer require unisharp/doc-us

1
2. 把 ServiceProvider 加進 config/app.php

‘providers’ => [
//

UniSharp\DocUs\DocUsServiceProvider::class,

/* ... */

];

1
3. 到 .env 把功能打開,預設關閉是避免資料庫結構自動曝露

DOC_US_ENABLE=true
```

三種結果演示

HTML

Alt text

Markdown

Alt text

JSON

Alt text

如果你也有相同的需求,不妨試試看,Github Repo 請看這裡,希望有幫助到你