专为IT人打造,类“swagger”自动API文档生成+团队文档+个人知识,国产开源的IT团队在线共享文档

鍓嶈█

澶у濂斤紝杩欓噷鏄彲鐖辩殑Cherry銆?/p>

绮変笣缇や綋鏈夋病鏈夊紑鍙戝ぇ浣憖锛熶綘浠湪鏁蹭唬鐮佺殑鏃跺€欐湁闅忔墜娉ㄩ噴鎴栬€呭啓鏂囨。鐨勪範鎯悧锛?/p>

瀵笴herry鏉ヨ锛屽綋瀵规帴鐨勫涓箼鏂逛簰鐩歌姹傛彁渚涙帴鍙ｆ枃妗ｅ拰鏁版嵁瀛楀吀鏃讹紝涔熷線寰€鏄垜澶存渶鐥涚殑鏃跺€欍€傛柊涓€鐐圭殑椤圭洰杩樺ソ璇达紝瑕佹眰涓ユ牸锛岃祫鏂欐枃妗ｉ綈鍏ㄣ€傝€佷竴鐐圭殑椤圭洰锛岄偅绠€鐩村氨鏄竴鍫嗕唬鐮佺矐绮戝北锛屼笉鍏変唬鐮佽川閲忔贩涔憋紝鐢氳嚦寰堝鎺ュ彛杩為」鐩粍浜哄憳閮芥悶涓嶆竻妤氥€?/p>

鍥犳锛屼竴涓笓闂ㄩ拡瀵笽T椤圭洰鐨勫洟闃熷崗璁瀷鍏变韩鏂囨。灏卞挨鍏堕噸瑕侊紝浠婂ぉ锛屾垜浠竴璧锋潵閮ㄧ讲杩欐閽堝鎬ф瀬寮虹殑IT鍥㈤槦鍦ㄧ嚎鍏变韩鏂囨。鈥斺€攕howdoc銆?/p>

鍊煎緱涓€鎻愮殑鏄紝showdoc涓嶄粎浠呭彧鏈夋枃妗ｇ鐞嗘湰韬紝浜у搧涓嬭繕鏈夋敮鎸佽嚜鍔ㄧ敓鎴恆pi鐨剅unapi宸ュ叿锛屾槸鍚﹁兘鏇夸唬swagger锛岃鎴戜滑鎷洰浠ュ緟銆?/p>

椤圭洰鍦板潃锛歨ttps://github.com/star7th/showdoc
椤圭洰鐗规€э細

馃憤API鏂囨。闅忕潃绉诲姩浜掕仈缃戠殑鍙戝睍锛孊aaS锛堝悗绔嵆鏈嶅姟锛夎秺鏉ヨ秺娴佽銆傛湇鍔＄鎻愪緵API锛孉PP绔垨鑰呯綉椤靛墠绔究鍙柟渚胯皟鐢ㄦ暟鎹€傜敤ShowDoc鍙互闈炲父鏂逛究蹇€熷湴缂栧啓鍑虹編瑙傜殑API鏂囨。銆傪煈嶆暟鎹瓧鍏镐竴浠藉ソ鐨勬暟鎹瓧鍏稿彲浠ュ緢鏂逛究鍦板悜鍒汉璇存槑浣犵殑鏁版嵁搴撶粨鏋勶紝濡傚悇涓瓧娈电殑閲婁箟绛夈€傪煈嶈鏄庢枃妗ｄ綘瀹屽叏鍙互浣跨敤showdoc鏉ョ紪鍐欎竴浜涘伐鍏风殑璇存槑涔?涔熷彲浠ョ紪鍐欎竴浜涙妧鏈鑼冭鏄庢枃妗ｄ互渚涘洟闃熸煡闃呫€傪煈嶅垎浜笌瀵煎嚭鍝嶅簲寮忕綉椤佃璁★紝鍙皢椤圭洰鏂囨。鍒嗕韩鍒扮數鑴戞垨绉诲姩璁惧鏌ョ湅銆傚悓鏃朵篃鍙互灏嗛」鐩鍑烘垚word鏂囦欢锛屼互渚跨绾挎祻瑙堛€傪煈嶆潈闄愮鐞? – 鍏紑椤圭洰涓庣瀵嗛」鐩細 ShowDoc涓婄殑椤圭洰鏈夊叕寮€椤圭洰鍜岀瀵嗛」鐩袱绉嶃€傚叕寮€椤圭洰鍙緵浠讳綍鐧诲綍涓庨潪鐧诲綍鐨勭敤鎴疯闂紝鑰岀瀵嗛」鐩垯闇€瑕佽緭鍏ュ瘑鐮侀獙璇佽闂€傚瘑鐮佺敱椤圭洰鍒涘缓鑰呰缃? – 椤圭洰杞锛氶」鐩垱寤鸿€呭彲浠ヨ嚜鐢卞湴鎶婇」鐩浆璁╃粰缃戠珯鐨勫叾浠栫敤鎴枫€? – 椤圭洰鎴愬憳锛氫綘鍙互寰堟柟渚垮湴涓篠howDoc鐨勯」鐩坊鍔犮€佸垹闄ら」鐩垚鍛樸€傞」鐩垚鍛樺彲浠ュ椤圭洰杩涜缂栬緫锛屼絾涓嶅彲杞鎴栧垹闄ら」鐩紙鍙湁椤圭洰鍒涘缓鑰呮墠鏈夋潈闄愶級 – 鍥㈤槦绠＄悊锛氬埄鐢╯howdoc鐨勫洟闃熷姛鑳戒綘鍙互鏇村ソ鍦拌繘琛屽洟闃熷崗浣滒煈嶇紪杈戝姛鑳? – markdown缂栬緫锛歋howDoc閲囩敤markdown缂栬緫鍣紝鏃犺鏄紪杈戣繕鏄槄璇讳綋楠岄兘鏋佷匠寰堟銆傚鏋滀綘涓嶄簡瑙arkdown锛岃鍦ㄦ悳绱㈠紩鎿庢悳绱⑩€濊璇嗕笌鍏ラ棬 Markdown鈥? – 妯℃澘鎻掑叆锛氬湪ShowDoc鐨勭紪杈戦〉闈紝鐐瑰嚮缂栬緫鍣ㄤ笂鏂圭殑鎸夐挳鍙柟渚垮湴鎻掑叆API鎺ュ彛妯℃澘鍜屾暟鎹瓧鍏告ā鏉裤€傛彃鍏ユā鏉垮悗锛屽墿涓嬬殑灏辨槸鏀瑰姩鏁版嵁浜嗭紝鐪佸幓浜嗗緢澶氱紪杈戠殑鍔涙皵銆? – 鍘嗗彶鐗堟湰锛歋howDoc涓洪〉闈㈡彁渚涘巻鍙茬増鏈姛鑳斤紝浣犲彲浠ユ柟渚垮湴鎶婇〉闈㈡仮澶嶅埌涔嬪墠鐨勭増鏈€傪煈嶅骞冲彴 – showdoc鏀寔缃戦〉鐗堛€佹墜鏈篴pp鐗堝拰鐢佃剳瀹㈡埛绔増銆傪煈嶈嚜鍔ㄥ寲 – 鍙粠浠ｇ爜娉ㄩ噴涓嚜鍔ㄧ敓鎴愭枃妗? – 鎼厤鐨凴unApi瀹㈡埛绔紝鍙皟璇曟帴鍙ｅ拰鑷姩鐢熸垚鏂囨。

绯荤粺閮ㄧ讲

涓€銆乨ocker-compose.yaml浠ｇ爜

馃敾鏂板缓鏂囦欢澶硅矾寰?volume1/showdoc/html锛屽湪/volume1/showdoc涓嬫柊寤?涓婁紶docker-compose.yml鏂囦欢锛屽皢涓嬮潰浠ｇ爜澶嶅埗杩涘幓銆?/p>

涓撲负IT浜烘墦閫?绫烩€渟wagger鈥濊嚜鍔ˋPI鏂囨。鐢熸垚+鍥㈤槦鏂囨。+涓汉鐭ヨ瘑,鍥戒骇寮€婧愮殑IT鍥㈤槦鍦ㄧ嚎鍏变韩鏂囨。

馃敾compose浠ｇ爜锛屾牴鎹嚜宸辩殑闇€瑕佷慨鏀?/p>

version: \’3\’

services:

showdoc:

image: star7th/showdoc

environment:

IN_CHINA: ${IN_CHINA:-false}

hostname: showdoc

ports:

– 4999:80 #澶栫綉绔彛锛屼笉鍐茬獊鍗冲彲

volumes:

– ./html:/var/www/html #鍙互鑷畾涔夎矾寰?/p>

restart: always

tty: true

networks:

– showdocnet

networks:

showdocnet: