All Projects → comdan66 → Oa Apidoc Template

comdan66 / Oa Apidoc Template

Live Demo

Programming Languages

javascript
184084 projects - #8 most used programming language

Projects that are alternatives of or similar to Oa Apidoc Template

Create Wxapp Page
创建微信小程序页面的命令行工具
Stars: ✭ 37 (-21.28%)
Mutual labels:  template
Workmanger
laravel+vue.js 前后端分离实战项目(项目中wx端等已经存在,因为涉及业务较多,不再更新到github 需要参考可以私聊我)
Stars: ✭ 41 (-12.77%)
Mutual labels:  template
Tail Kit
Tail-kit is a free and open source components and templates kit fully coded with Tailwind css 2.0.
Stars: ✭ 997 (+2021.28%)
Mutual labels:  template
Cookiecutter Flask Pythonic
Pythonic starter boilerplate for Flask
Stars: ✭ 37 (-21.28%)
Mutual labels:  template
Nuxt Template
🗃 Nuxt Template (Typescript + Composition API)
Stars: ✭ 40 (-14.89%)
Mutual labels:  template
Vue Template With Element Ui
A Vue.js template with element UI.
Stars: ✭ 42 (-10.64%)
Mutual labels:  template
Kotlin Android Template
Android + Kotlin + Github Actions + ktlint + Detekt + Gradle Kotlin DSL + buildSrc = ❤️
Stars: ✭ 984 (+1993.62%)
Mutual labels:  template
Bug Bounty Responses
A collection of response templates for invalid bug bounty reports.
Stars: ✭ 46 (-2.13%)
Mutual labels:  template
Admin Template Night
Tailwind CSS Starter Template - Admin Dashboard Template (Night Mode)
Stars: ✭ 40 (-14.89%)
Mutual labels:  template
Bootstrap4layouts
A Template for Bootstrap 4 based on my Bootstrap 4 Layouts course on LinkedIn Learning
Stars: ✭ 44 (-6.38%)
Mutual labels:  template
Nucleo
🔴 Nucleo - Admin template and Starter project for React
Stars: ✭ 38 (-19.15%)
Mutual labels:  template
Auth Template
A starting point for Vapor applications using the auth provider.
Stars: ✭ 39 (-17.02%)
Mutual labels:  template
Django Preserialize
Convert your model instances and querysets into dicts and list with style.
Stars: ✭ 42 (-10.64%)
Mutual labels:  template
Chalk
Chalk is a high quality, completely customizable, performant and 100% free Jekyll blog theme.
Stars: ✭ 987 (+2000%)
Mutual labels:  template
Phaser3template
heroku deployable webpacked phaser3 template with socket.io for multi or single player games
Stars: ✭ 44 (-6.38%)
Mutual labels:  template
Collection
🚩 Anno 1800 Mod Collection
Stars: ✭ 37 (-21.28%)
Mutual labels:  template
Think
ThinkPHP Framework ——十年匠心的高性能PHP框架
Stars: ✭ 7,681 (+16242.55%)
Mutual labels:  template
Jekyll Timeline
Timeline / Résumé Theme with Jekyll
Stars: ✭ 46 (-2.13%)
Mutual labels:  template
Latexcv
👔 A collection of cv and resume templates written in LaTeX. Leave an issue if your language is not supported!
Stars: ✭ 1,027 (+2085.11%)
Mutual labels:  template
Phug
Phug - The Pug Template Engine for PHP
Stars: ✭ 43 (-8.51%)
Mutual labels:  template

Welcome To OA's apiDoc Template!

相信大家不管身為前端還是後端的各位大大們,在開發前後端串接或多或少都有使用過 apiDoc 吧!?
沒錯!這個是 OA 我自己寫的 apiDoc 的 Template 樣板!有興趣的話,歡迎各位看一下玩玩看囉!

使用的工具不難,版型是用 scss 刻的,JavaScript 也僅用 jQuery
流程主要是藉由 Ajax 取得編譯後的 api_data.jsonapi_project.json 然後再產生 HTML 畫面。

若是各位大大們覺得有趣的話,歡迎在此 GitHub 專案右上角幫我按一下 星星 給我個鼓勵吧!


聲明

本作品授權採用 姓名標示-非商業性 2.0 台灣 (CC BY-NC 2.0 TW) 授權,詳見 http://creativecommons.org/licenses/by-nc/2.0/tw/

說明

  • 此樣板是使用 OA 個人開發的前端工具 OAF2E 所製作的。
  • 本架構下使用 jQuerycompassGulp 開發。
  • 本樣板沒有支援 100% 所有 apiDoc 的功能喔!所以使用前請先斟酌評估功能。

使用方法

  • 請先確認電腦是否已完成安裝 apiDoc
  • 請開啟 終端機,並且移到專案目錄下。
  • 下指令 apidoc -i api_forder -t template_forder

舉例

  • 假設 API 專案目錄是在 /var/www/project/app/controller/api/
  • 下載的 Template 目錄在 /var/www/OA-apiDoc-Template/
  • 終端機位置移到欲產生文件的位置,例如:/var/www/,所以下指令:cd /var/www/
  • 產生文件就指令為:apidoc -i /var/www/project/app/controller/api/ -t /var/www/OA-apiDoc-Template/
  • 產生的文件檔案就會在:/var/www/doc/
  • 假設伺服器 127.0.0.1 是指向 /var/www/,那就可以打開瀏覽器檢視 http://127.0.0.1/doc/

關於

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].