Slide 1

Slide 1 text

஠ೖமਵ۽ द੘ೞח য়೑ࣗझ ash84

Slide 2

Slide 2 text

ash84 • Developer • [email protected] • ash84.net • @sh84ahn • github.com/AhnSeongHyun 

Slide 3

Slide 3 text

੉۠ ೐۽ં౟ܳ ೞҊ ੓णפ׮. • Plate : API Documentation Tool based on markdown. • https://github.com/Plate-Project/plate • http://plate-project.github.io/ 

Slide 4

Slide 4 text

ѐߊೞѱ ػ ҅ӝ • ੑࢎ 3ѐਘର(नੑ਷ ইש), ೠହ ੄਄݅ খࢸ दӝ • API ੘স ੹, ࢸ҅ ୡউ ੘সҗ ೣԋ API ޙࢲച ో ઑࢎ • Ѿઁ ҙ۲ API ࢎ੉౟ٜਸ ઱۽ ଵҊ 

Slide 5

Slide 5 text

more test • Swagger • http://petstore.swagger.io/ • I/O Docs • https://github.com/mashery/iodocs • http://blog.outsider.ne.kr/990 

Slide 6

Slide 6 text

more doc  • Slate • https://github.com/tripit/slate • Atlassian/Confulence

Slide 7

Slide 7 text

Stripe API Docs

Slide 8

Slide 8 text

ҶҶҶ • ӝઓߑध - *.docx, *.xlsx + sample code • asp.net_example.zip, jsp_example.zip • সؘ੉౟о औ૑ ঋ׮. 

Slide 9

Slide 9 text

ҶҶҶ • Stripe э਷ API ޙࢲച ࢎ੉౟ܳ ੉ਊೞݶ.. • API ܳ पઁ ௏٘৬ ೣԋ ࠅࣻ ੓׮ח ੢੼. • APIܳ সؘ੉౟ ೞ؊ۄب, ખ ؊ औѱ ޙࢲ৬ ௏٘ܳ э੉ সؘ੉౟ оמ. 

Slide 10

Slide 10 text

׹੿ց - slate • slate ۽ ੿ೞҊ ࢓ಝࠁӝ द੘. • য঺, ੉Ѥ ܖ࠺. ܖ࠺ח ࢎیੑפ׮. 

Slide 11

Slide 11 text

࠙ࢳ • ҳࢿ • middleman : static site generator based Ruby • layout.erb - మ೒݁ • index.md - APIޙࢲ • ѾҴ.. 1. index.md ਸ ߸ജ 2. middleman ਸ ੉ਊ೧ࢲ layout.erb ী ֍Ҋ 3. HTML ۽ ୹۱. 

Slide 12

Slide 12 text

conv2python  • ખ؊ ੊ࣼೠ ঱য৬ ജ҃ ࢎਊ. ࢎप਷ slate ج۰ࠁ׮ ૑୛ࢲ… • ౱ղ ઱ ঱য۽ ౵੉ॆਸ ޻Ҋ ੓ח ࢚క • ܖ࠺৬ о੢ ࠺तೠ?

Slide 13

Slide 13 text

conv2python  • Middleman TO Flask • jinja2 template • layout.erb to /templates/index.html

Slide 14

Slide 14 text

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"])


              

Slide 15

Slide 15 text

conv2python  ```python
 codes
 ```
 
 ```java 
 codes
 ```


codes



codes

markdown html

Slide 16

Slide 16 text

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())


Slide 17

Slide 17 text

 ߸ജೞҊ, ֍ਵݶ, ՘.

Slide 18

Slide 18 text

slate-flask ۽ github ҕѐ • ੉ਬ : • ইө਑. • ա୊ۢ Ruby ী ੊ࣼೞ૑ ঋ਷ ࢎۈب ੓૑ ঋਸө. ҕѐ ೞա݃ա. য়೑݅ ػ. • ॶҔਸ ଺ইࠁ੗. ইפ ղо ॳ੗. ঌ߄ೞח ࢲߡAPI ޙࢲചী ੸ਊ. • ॄࠁפ, উજ਷ ࠗ࠙੉ ࠁ੉ӝ द੘. 

Slide 19

Slide 19 text

ӝמ୶о • ݣ౭ ݃௼׮਍ ӝמ ୶о • watchdog ӝמ ୶о 

Slide 20

Slide 20 text

ݣ౭ ݃௼׮਍ ӝמ • ੿ഋചػ ٣۩షܻо ইצ ࢎਊ੗о ҃۽ܳ ૑੿. • ݾର ࢚ী ಴दغח ࣽࢲب ੿ೞب۾ ૑੿. • index.json {
 "ORDER":
 [
 "Introduction.md",
 "Signup.md",
 "Signin.md", 
 "Notice.md", 
 "Notice.jp.md", 
 "Notice.fr.md"
 ]
 } 
 
 

Slide 21

Slide 21 text

• ݅ড, API ޙࢲо ࣻ੿ػ׮ݶ? • ࢲߡܳ Տ׮. • API ޙࢲܳ Ҋ஘׮. • ׮द ࢲߡܳ ৢܽ׮. • ޙࢲܳ ࣻ੿ೞݶ ߄۽ ࢲߡо ੗زਵ۽ ੋध೧ࢲ ղਊਸ ߄Լ઱੗. 

Slide 22

Slide 22 text

watchdog • ࢲߡ۽ ڸ਋ݶ, ߄۽ хद द੘. • ޙࢲо ߸҃غݶ, ׮਺ ਃ୒द ׮द html ٜ݅ӝ ࣻ೯ 

Slide 23

Slide 23 text

EMOCON 2015 F/W ળ࠺ೞݶࢲ ୶оೠ ղਊٜ. • slate-flask to Plate-Project/plate : organization • postman2md • multi-language searching • static html 

Slide 24

Slide 24 text

ࢲߡ API ѐߊद੄ ಁఢ • ࢎਊೠ పझ౴ਸ ޙࢲ۽ ٜ݅ࣻ ੓૑ ঋਸө? postman2md • postman collection json ਸ markdown ਵ۽ ߸ജ • ߸ജػ markdown ਸ ޙࢲചী ੉ਊ(plateী ੉ਊ) • postman collection json with plate  testing "1* %FTJHO doc dev

Slide 25

Slide 25 text

Ѩ࢝੄ ޙઁ : lunr.js ੉ਊ • ৔য݅ਸ ૑ਗೞח ޙઁ, ׮Ҵয ૑ਗ੄ ੉ग • lunr-languages ܳ plate ী োز, ݻ ѐ੄ ׮Ҵয Ѩ࢝ оמ. • അ੤ ೠҴযо হযࢲ lunr.kr.js ܳ ٜ݅Ҋ ੓ח ઺ 

Slide 26

Slide 26 text

static html • ࢎप ௼ѱ ࢤпೞ૑ ঋও؍ ӝמ. • github.io э਷ Ҕী ৢܻѢա Apacheী ৢܽ׮ݶ • ਗې Flask ח jinja2 template ܳ ੉ਊ, ߸ജػ HTML ਸ ੷੢ • http://plate-project.github.io/ 

Slide 27

Slide 27 text

খਵ۽੄ ҅ദ • ী٣ఠ • పझ౴ࠗ࠙੄ ୶о : slateীب Բળೠ ੉ग • ஠ೖம੄ ఎೖ - Front-End • ઑӘ਷ ׮ܲ ߑೱਵ۽੄ API Documentation Toolਸ ٜ݅Ҋ र׮. 

Slide 28

Slide 28 text

য়೑ࣗझ द੘ೞӝ • ௏٘સӝ vs. ஠ೖம • ੢ױ੼੉ ੓ח ٠, ѐੋ੄ ࢿೱ 

Slide 29

Slide 29 text

যڌѱ ҅ࣘ ਬ૑ೡࣻ ੓חо? • ೠߣ द੘ೠѪਸ ҅ࣘ ਬ૑ೞחѪ਷ औ૑о ঋ਺. • ౠ൤ ஠ೖம਷ ؊ Ӓ۠٠. • ॄࠁҊ ҅ࣘ ѐࢶೡ Ѣܻܳ ݅٘ח Ѫ੉ ੗ӓ੉ ؽ. • ૑ࣘ੸ਵ۽ ೡࣻ ੓חѪਸ ࢶఖೞӡ. 

Slide 30

Slide 30 text

૑ெࠁҊ ੓ӝ.  • issue, pull request • ೙ਃೠ ӝמٜਸ ଺ইղח ઺.

Slide 31

Slide 31 text

যڌѱ જ਷ য়೑ࣗझо ؼࣻ ੓ਸө? • fork count? star? • ৈ੹൤ ݽܰѷ਺. ࣼઁ • ଺ইоח җ੿ 

Slide 32

Slide 32 text

For me • ૑ࣘ੸ਵ۽ ѐߊೡ Ѣܻ, daily commit • ҙ۲ػ ׮নೠ য়೑ࣗझী ؀ೠ ੽Ӕ. 

Slide 33

Slide 33 text

Thank you