Builder.php 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220
  1. <?php
  2. namespace app\admin\command\Api\library;
  3. use think\Config;
  4. /**
  5. * @website https://github.com/calinrada/php-apidoc
  6. * @author Calin Rada <rada.calin@gmail.com>
  7. * @author Karson <karsonzhang@163.com>
  8. */
  9. class Builder
  10. {
  11. /**
  12. *
  13. * @var \think\View
  14. */
  15. public $view = null;
  16. /**
  17. * parse classes
  18. * @var array
  19. */
  20. protected $classes = [];
  21. /**
  22. *
  23. * @param array $classes
  24. */
  25. public function __construct($classes = [])
  26. {
  27. $this->classes = array_merge($this->classes, $classes);
  28. $this->view = new \think\View(Config::get('template'), Config::get('view_replace_str'));
  29. }
  30. protected function extractAnnotations()
  31. {
  32. $st_output = [];
  33. foreach ($this->classes as $class)
  34. {
  35. if(!empty($class)) {
  36. $st_output[] = Extractor::getAllClassAnnotations($class);
  37. }
  38. }
  39. return end($st_output);
  40. }
  41. protected function generateHeadersTemplate($docs)
  42. {
  43. if (!isset($docs['ApiHeaders']))
  44. {
  45. return [];
  46. }
  47. $headerslist = array();
  48. foreach ($docs['ApiHeaders'] as $params)
  49. {
  50. $tr = array(
  51. 'name' => $params['name'],
  52. 'type' => $params['type'],
  53. 'sample' => isset($params['sample']) ? $params['sample'] : '',
  54. 'required' => isset($params['required']) ? $params['required'] : false,
  55. 'description' => isset($params['description']) ? $params['description'] : '',
  56. );
  57. $headerslist[] = $tr;
  58. }
  59. return $headerslist;
  60. }
  61. protected function generateParamsTemplate($docs)
  62. {
  63. if (!isset($docs['ApiParams']))
  64. {
  65. return [];
  66. }
  67. $paramslist = array();
  68. foreach ($docs['ApiParams'] as $params)
  69. {
  70. $tr = array(
  71. 'name' => $params['name'],
  72. 'type' => isset($params['type']) ? $params['type'] : 'string',
  73. 'sample' => isset($params['sample']) ? $params['sample'] : '',
  74. 'required' => isset($params['required']) ? $params['required'] : true,
  75. 'description' => isset($params['description']) ? $params['description'] : '',
  76. );
  77. $paramslist[] = $tr;
  78. }
  79. return $paramslist;
  80. }
  81. protected function generateReturnHeadersTemplate($docs)
  82. {
  83. if (!isset($docs['ApiReturnHeaders']))
  84. {
  85. return [];
  86. }
  87. $headerslist = array();
  88. foreach ($docs['ApiReturnHeaders'] as $params)
  89. {
  90. $tr = array(
  91. 'name' => $params['name'],
  92. 'type' => 'string',
  93. 'sample' => isset($params['sample']) ? $params['sample'] : '',
  94. 'required' => isset($params['required']) && $params['required'] ? 'Yes' : 'No',
  95. 'description' => isset($params['description']) ? $params['description'] : '',
  96. );
  97. $headerslist[] = $tr;
  98. }
  99. return $headerslist;
  100. }
  101. protected function generateReturnParamsTemplate($st_params)
  102. {
  103. if (!isset($st_params['ApiReturnParams']))
  104. {
  105. return [];
  106. }
  107. $paramslist = array();
  108. foreach ($st_params['ApiReturnParams'] as $params)
  109. {
  110. $tr = array(
  111. 'name' => $params['name'],
  112. 'type' => isset($params['type']) ? $params['type'] : 'string',
  113. 'sample' => isset($params['sample']) ? $params['sample'] : '',
  114. 'description' => isset($params['description']) ? $params['description'] : '',
  115. );
  116. $paramslist[] = $tr;
  117. }
  118. return $paramslist;
  119. }
  120. protected function generateBadgeForMethod($data)
  121. {
  122. $method = strtoupper(is_array($data['ApiMethod'][0]) ? $data['ApiMethod'][0]['data'] : $data['ApiMethod'][0]);
  123. $labes = array(
  124. 'POST' => 'label-primary',
  125. 'GET' => 'label-success',
  126. 'PUT' => 'label-warning',
  127. 'DELETE' => 'label-danger',
  128. 'PATCH' => 'label-default',
  129. 'OPTIONS' => 'label-info'
  130. );
  131. return isset($labes[$method]) ? $labes[$method] : $labes['GET'];
  132. }
  133. public function parse()
  134. {
  135. $annotations = $this->extractAnnotations();
  136. $counter = 0;
  137. $section = null;
  138. $docslist = [];
  139. foreach ($annotations as $class => $methods)
  140. {
  141. foreach ($methods as $name => $docs)
  142. {
  143. if (isset($docs['ApiSector'][0]))
  144. {
  145. $section = is_array($docs['ApiSector'][0]) ? $docs['ApiSector'][0]['data'] : $docs['ApiSector'][0];
  146. }
  147. else
  148. {
  149. $section = $class;
  150. }
  151. if (0 === count($docs))
  152. {
  153. continue;
  154. }
  155. $docslist[$section][] = [
  156. 'id' => $counter,
  157. 'method' => is_array($docs['ApiMethod'][0]) ? $docs['ApiMethod'][0]['data'] : $docs['ApiMethod'][0],
  158. 'method_label' => $this->generateBadgeForMethod($docs),
  159. 'section' => $section,
  160. 'route' => is_array($docs['ApiRoute'][0]) ? $docs['ApiRoute'][0]['data'] : $docs['ApiRoute'][0],
  161. 'summary' => is_array($docs['ApiSummary'][0]) ? $docs['ApiSummary'][0]['data'] : $docs['ApiSummary'][0],
  162. 'body' => isset($docs['ApiBody'][0]) ? is_array($docs['ApiBody'][0]) ? $docs['ApiBody'][0]['data'] : $docs['ApiBody'][0] : '',
  163. 'headerslist' => $this->generateHeadersTemplate($docs),
  164. 'paramslist' => $this->generateParamsTemplate($docs),
  165. 'returnheaderslist' => $this->generateReturnHeadersTemplate($docs),
  166. 'returnparamslist' => $this->generateReturnParamsTemplate($docs),
  167. 'return' => isset($docs['ApiReturn']) ? is_array($docs['ApiReturn'][0]) ? $docs['ApiReturn'][0]['data'] : $docs['ApiReturn'][0] : '',
  168. ];
  169. $counter++;
  170. }
  171. }
  172. return $docslist;
  173. }
  174. public function getView()
  175. {
  176. return $this->view;
  177. }
  178. /**
  179. * 渲染
  180. * @param string $template
  181. * @param array $vars
  182. * @return string
  183. */
  184. public function render($template, $vars = [])
  185. {
  186. $docslist = $this->parse();
  187. return $this->view->display(file_get_contents($template), array_merge($vars, ['docslist' => $docslist]));
  188. }
  189. }