Introduction of Plate(python slate : API Documentation Tool based markdown)
ೖமਵ۽ दೞח য়ࣗझash84
View Slide
ash84• Developer• [email protected]• ash84.net• @sh84ahn• github.com/AhnSeongHyun
۠ ۽ંܳ ೞҊ णפ.• Plate : API Documentation Tool based on markdown.• https://github.com/Plate-Project/plate• http://plate-project.github.io/
ѐߊೞѱ ػ ҅ӝ• ੑࢎ 3ѐਘର(नੑ ইש), ೠହ ݅ খࢸ दӝ• API স , ࢸ҅ ୡউ সҗ ೣԋ API ޙࢲച ో ઑࢎ• Ѿઁ ҙ۲ API ࢎٜਸ ۽ ଵҊ
more test• Swagger• http://petstore.swagger.io/• I/O Docs• https://github.com/mashery/iodocs• http://blog.outsider.ne.kr/990
more doc• Slate• https://github.com/tripit/slate• Atlassian/Confulence
Stripe API Docs
ҶҶҶ• ӝઓߑध - *.docx, *.xlsx + sample code• asp.net_example.zip, jsp_example.zip• সؘо औ ঋ.
ҶҶҶ• Stripe э API ޙࢲച ࢎܳ ਊೞݶ..• API ܳ पઁ ٘৬ ೣԋ ࠅࣻ ח .• APIܳ সؘ ೞ؊ۄب, ખ ؊ औѱ ޙࢲ৬ ٘ܳ э সؘ оמ.
ց - slate• slate ۽ ೞҊ ಝࠁӝ द.• য, Ѥ ܖ࠺. ܖ࠺ח ࢎیੑפ.
࠙ࢳ• ҳࢿ• middleman : static site generator based Ruby• layout.erb - మ݁• index.md - APIޙࢲ• ѾҴ..1. index.md ਸ ߸ജ2. middleman ਸ ਊ೧ࢲ layout.erb ী ֍Ҋ3. HTML ۽ ۱.
conv2python• ખ؊ ࣼೠ য৬ ജ҃ ࢎਊ. ࢎप slate ج۰ࠁ ࢲ…• ղ য۽ ॆਸ Ҋ ח ࢚క• ܖ࠺৬ о ࠺तೠ?
conv2python• Middleman TO Flask• jinja2 template• layout.erb to /templates/index.html
conv2python• markdown to html• markdown : ߸ജ ߂ নೠ ഛ ݽٕ ઁҕ• fence_codes : markdown code block to • tables : markdown table syntax to import markdown return markdown.markdown(md_text, extensions=["fenced_code", "tables"])
conv2python```python codes ``` ```java codes ``` codes codes markdown html
conv2python• Code Syntax Highlighting• pygments : Python syntax highlighter• নೠ ۽Ӓې߁ & ݃স য ޙߨ ਗ from pygments import highlight from pygments.lexers import PythonLexer from pygments.lexers import JavaLexer from pygments.formatters import HtmlFormatter highlighted = highlight(code, PythonLexer(), HtmlFormatter()) highlighted = highlight(code, JavaLexer(), HtmlFormatter())
߸ജೞҊ, ֍ਵݶ, .
slate-flask ۽ github ҕѐ• ਬ :• ইө.• աۢ Ruby ী ࣼೞ ঋ ࢎۈب ঋਸө.ҕѐ ೞա݃ա. য়݅ ػ.• ॶҔਸ ইࠁ. ইפ ղо ॳ. ঌ߄ೞח ࢲߡAPI ޙࢲചী ਊ.• ॄࠁפ, উજ ࠗ࠙ ࠁӝ द.
ӝמ୶о• ݣ౭ ݃ ӝמ ୶о• watchdog ӝמ ୶о
ݣ౭ ݃ ӝמ• ഋചػ ٣۩షܻо ইצ ࢎਊо ҃۽ܳ .• ݾର ࢚ী दغח ࣽࢲب ೞب۾ .• index.json{ "ORDER": [ "Introduction.md", "Signup.md", "Signin.md", "Notice.md", "Notice.jp.md", "Notice.fr.md" ] }
• ݅ড, API ޙࢲо ࣻػݶ?• ࢲߡܳ Տ.• API ޙࢲܳ Ҋ.• द ࢲߡܳ ৢܽ.• ޙࢲܳ ࣻೞݶ ߄۽ ࢲߡо زਵ۽ ੋध೧ࢲ ղਊਸ ߄Լ.
watchdog• ࢲߡ۽ ڸݶ, ߄۽ хद द.• ޙࢲо ߸҃غݶ, ਃद द html ٜ݅ӝ ࣻ೯
EMOCON 2015 F/W ળ࠺ೞݶࢲ ୶оೠ ղਊٜ.• slate-flask to Plate-Project/plate : organization• postman2md• multi-language searching• static html
ࢲߡ API ѐߊद ಁఢ• ࢎਊೠ పझਸ ޙࢲ۽ ٜ݅ࣻ ঋਸө?postman2md• postman collection json ਸ markdown ਵ۽ ߸ജ• ߸ജػ markdown ਸ ޙࢲചী ਊ(plateী ਊ)• postman collection json with platetesting"1*%FTJHOdocdev
Ѩ࢝ ޙઁ : lunr.js ਊ• য݅ਸ ਗೞח ޙઁ, Ҵয ਗ ग• lunr-languages ܳ plate ী োز, ݻ ѐ Ҵয Ѩ࢝ оמ.• അ ೠҴযо হযࢲ lunr.kr.js ܳ ٜ݅Ҋ ח
static html• ࢎप ѱ ࢤпೞ ঋও؍ ӝמ.• github.io э Ҕী ৢܻѢա Apacheী ৢܽݶ• ਗې Flask ח jinja2 template ܳ ਊ, ߸ജػ HTML ਸ • http://plate-project.github.io/
খਵ۽ ҅ദ• ী٣ఠ• పझࠗ࠙ ୶о : slateীب Բળೠ ग• ೖம ఎೖ - Front-End• ઑӘ ܲ ߑೱਵ۽ API Documentation Toolਸ ٜ݅Ҋ र.
য়ࣗझ दೞӝ• ٘સӝ vs. ೖம• ױ ח ٠, ѐੋ ࢿೱ
যڌѱ ҅ࣘ ਬೡࣻ חо?• ೠߣ दೠѪਸ ҅ࣘ ਬೞחѪ औо ঋ.• ౠ ೖம ؊ Ӓ۠٠.• ॄࠁҊ ҅ࣘ ѐࢶೡ Ѣܻܳ ݅٘ח Ѫ ӓ ؽ.• ࣘਵ۽ ೡࣻ חѪਸ ࢶఖೞӡ.
ெࠁҊ ӝ.• issue, pull request• ਃೠ ӝמٜਸ ইղח .
যڌѱ જ য়ࣗझо ؼࣻ ਸө?• fork count? star?• ৈ ݽܰѷ. ࣼઁ• ইоח җ
For me• ࣘਵ۽ ѐߊೡ Ѣܻ, daily commit• ҙ۲ػ নೠ য়ࣗझী ೠ Ӕ.
Thank you