Apidoc: рдХреНрдпрд╛ рдЕрд▓рдЧ apidoc.json рд╕реЗрдЯ рдХрд░рдиреЗ рдХрд╛ рдХреЛрдИ рддрд░реАрдХрд╛ рд╣реИ?

рдХреЛ рдирд┐рд░реНрдорд┐рдд 12 рдЕрдкреНрд░реИрд▓ 2018  ┬╖  6рдЯрд┐рдкреНрдкрдгрд┐рдпрд╛рдБ  ┬╖  рд╕реНрд░реЛрдд: apidoc/apidoc

рдирдорд╕реНрддреЗ!
рд▓реЛрдХрд▓рд╣реЛрд╕реНрдЯ рдПрдирд╡реА рдореЗрдВ рдХрд╛рдо рдХрд░рддреЗ рд╣реБрдП, рд╣рдо 'рдирдореВрдирд╛ рдпреВрдЖрд░рдПрд▓' рдХреЛ рд▓реЛрдХрд▓рд╣реЛрд╕реНрдЯ рд╣реЛрд╕реНрдЯ рдХреЗ рд░реВрдк рдореЗрдВ рд╕реЗрдЯ рдХрд░рдирд╛ рдЪрд╛рд╣рддреЗ рд╣реИрдВ, рддрд╛рдХрд┐ рдЕрдзрд┐рдХ рдЖрд╕рд╛рдиреА рд╕реЗ рдкрд░реАрдХреНрд╖рдг рдХрд┐рдпрд╛ рдЬрд╛ рд╕рдХреЗред рдЬрдмрдХрд┐ рд╣рдореЗрдВ рдЕрднреА рднреА рдЗрд╕реЗ рдмрд╛рд░-рдмрд╛рд░ рдмрдирд╛рдП рд░рдЦрдиреЗ рдХреА рдЖрд╡рд╢реНрдпрдХрддрд╛ рд╣реЛрддреА рд╣реИ, рдЗрд╕рд▓рд┐рдП рдЗрд╕реЗ .gitignore рдореЗрдВ рд░рдЦрдирд╛ рдЕрдЪреНрдЫрд╛ рдирд╣реАрдВ рд╣реИред

apidoc.json рдХреЗ рд▓рд┐рдП рдкрде рд╕реЗрдЯ рдХрд░рдиреЗ рдХрд╛ рд╡рд┐рдХрд▓реНрдк рдкреНрд░рджрд╛рди рдХрд░рдиреЗ рдХреЗ рдмрд╛рд░реЗ рдореЗрдВ рдХреИрд╕реЗ?

рдзрдиреНрдпрд╡рд╛рдж!

enhancement fixed on dev

рд╕рдмрд╕реЗ рдЙрдкрдпреЛрдЧреА рдЯрд┐рдкреНрдкрдгреА

рдореБрдЭреЗ рдкреНрд░рддреНрдпреЗрдХ apidoc.json рд▓рд┐рдП рдирд┐рд░реНрджреЗрд╢рд┐рдХрд╛ рдмрдирд╛рдиреЗ рдХреА рдЖрд╡рд╢реНрдпрдХрддрд╛ рдХреНрдпреЛрдВ рд╣реИ? рдореИрдВ рдлрд╝рд╛рдЗрд▓ рдХреЗ рд▓рд┐рдП рдкрде рдирд┐рд░реНрджрд┐рд╖реНрдЯ рдХреНрдпреЛрдВ рдирд╣реАрдВ рдХрд░ рд╕рдХрддрд╛?

apidoc -c ./apidoc-test.json рдЬреИрд╕рд╛ рдХреБрдЫ рдмрд╣реБрдд рдмреЗрд╣рддрд░ рд╣реЛрдЧрд╛ред

рд╕рднреА 6 рдЯрд┐рдкреНрдкрдгрд┐рдпрд╛рдБ

рдореИрдВрдиреЗ рд╡рд┐рднрд┐рдиреНрди рд╡рд╛рддрд╛рд╡рд░рдгреЛрдВ рдХреЗ рд▓рд┐рдП рджрд╕реНрддрд╛рд╡реЗрдЬрд╝ рдЙрддреНрдкрдиреНрди рдХрд░рдиреЗ рд╡рд╛рд▓реА рдПрдХ рд╣реА рд╕рдорд╕реНрдпрд╛ рдХреЛ рднреА рдареЛрдХрд░ рдЦрд╛рдИред
рдореИрдВ рджреЗрдЦрддрд╛ рд╣реВрдВ рдХрд┐ рдХрдИ рд╕рдорд╛рдзрд╛рди рд╣реЛ рд╕рдХрддреЗ рд╣реИрдВ:

  • рдкреНрд░рддреНрдпреЗрдХ рдирд┐рд░реНрдорд╛рдг рдХреЗ рд▓рд┐рдП рдлреНрд▓рд╛рдИ рдкрд░ apidoc.json рдЙрддреНрдкрдиреНрди рдХрд░реЗрдВ (рд╡рд╣ рдЕрдЪреНрдЫрд╛ рдирд╣реАрдВ рд╣реИ)
  • apidoc.js рдХреЙрдиреНрдлрд╝рд┐рдЧрд░реЗрд╢рди рдХрд╛ рдЙрдкрдпреЛрдЧ рдХрд░рдиреЗ рдХрд╛ рд╡рд┐рдХрд▓реНрдк рд╣реИ, рдЗрд╕рд▓рд┐рдП рд╕рднреА рдЪрд░ рд░рди-рдЯрд╛рдЗрдо рдореЗрдВ рдЙрддреНрдкрдиреНрди рдХрд┐рдП рдЬрд╛ рд╕рдХрддреЗ рд╣реИрдВ

рд╕рд╛рде рд╣реА, рджрд╕реНрддрд╛рд╡реЗрдЬрд╝реАрдХрд░рдг рдХреЗ рдЕрдиреБрд╕рд╛рд░, рдПрдХ рдХреЙрдиреНрдлрд╝рд┐рдЧрд░реЗрд╢рди рд╕реНрд╡рд┐рдЪ рд╣реИ, рдЬреЛ рднреА рдХрд╛рдо рдХрд░ рд╕рдХрддрд╛ рд╣реИ, рд▓реЗрдХрд┐рди рдЖрдк рдкреВрд░реА рдлрд╝рд╛рдЗрд▓ рдХреЛ рдХреЙрдкреА-рдкреЗрд╕реНрдЯ рдХрд░ рджреЗрдВрдЧреЗ

   -c, --config            Path to directory containing config file (apidoc.json)  [./]

рдореБрдЭреЗ рдкреНрд░рддреНрдпреЗрдХ apidoc.json рд▓рд┐рдП рдирд┐рд░реНрджреЗрд╢рд┐рдХрд╛ рдмрдирд╛рдиреЗ рдХреА рдЖрд╡рд╢реНрдпрдХрддрд╛ рдХреНрдпреЛрдВ рд╣реИ? рдореИрдВ рдлрд╝рд╛рдЗрд▓ рдХреЗ рд▓рд┐рдП рдкрде рдирд┐рд░реНрджрд┐рд╖реНрдЯ рдХреНрдпреЛрдВ рдирд╣реАрдВ рдХрд░ рд╕рдХрддрд╛?

apidoc -c ./apidoc-test.json рдЬреИрд╕рд╛ рдХреБрдЫ рдмрд╣реБрдд рдмреЗрд╣рддрд░ рд╣реЛрдЧрд╛ред

рдореИрдВ рд╕рд╣рдордд рд╣реВрдВ рдХрд┐ -c рдзреНрд╡рдЬ рдПрдХ рдХреЙрдиреНрдлрд╝рд┐рдЧрд░реЗрд╢рди рдлрд╝рд╛рдЗрд▓ рдХреЗ рд▓рд┐рдП рд╣реЛрдирд╛ рдЪрд╛рд╣рд┐рдП, рдирд┐рд░реНрджреЗрд╢рд┐рдХрд╛ рдирд╣реАрдВред рдкрд╢реНрдЪрдЧрд╛рдореА рд╕рдВрдЧрддрддрд╛ рдХреЗ рд▓рд┐рдП, рдХреЛрдб рдХреЛ рдпрд╣ рдирд┐рд░реНрдзрд╛рд░рд┐рдд рдХрд░рдиреЗ рдХреА рдЖрд╡рд╢реНрдпрдХрддрд╛ рд╣реЛрдЧреА рдХрд┐ рдХреНрдпрд╛ рдкрде рдПрдХ рдирд┐рд░реНрджреЗрд╢рд┐рдХрд╛ рдпрд╛ рдлрд╝рд╛рдЗрд▓ рд╣реИ, рдпрджрд┐ рдХреЛрдИ рдлрд╝рд╛рдЗрд▓ рд╣реИ, рддреЛ рд╕реАрдзреЗ рдЙрд╕рдХрд╛ рдЙрдкрдпреЛрдЧ рдХрд░реЗрдВ, рдпрджрд┐ рдХреЛрдИ рдирд┐рд░реНрджреЗрд╢рд┐рдХрд╛ рд╣реИ, рддреЛ рдЕрдВрджрд░ рдХреЙрдиреНрдлрд╝рд┐рдЧрд░реЗрд╢рди рдлрд╝рд╛рдЗрд▓ рджреЗрдЦреЗрдВред

рдХреНрдпрд╛ рдпрд╣ dotenv lib рдХрд╛ рдЙрдкрдпреЛрдЧ рдХрд░ рд╕рдХрддрд╛ рд╣реИ? рд╣рдо рдЕрдкрдиреЗ рдЬреЗрдирд░реЗрдЯ рдХрд┐рдП рдЧрдП рджрд╕реНрддрд╛рд╡реЗрдЬрд╝реЛрдВ рдХреЛ рдПрдХ рдбреЙрдХрд░ рдЫрд╡рд┐ рдореЗрдВ рд░рдЦ рд░рд╣реЗ рд╣реИрдВ рдЬрд┐рд╕реЗ рд╡рд┐рднрд┐рдиреНрди рд╡рд╛рддрд╛рд╡рд░рдгреЛрдВ рдореЗрдВ рдзрдХреЗрд▓ рджрд┐рдпрд╛ рдЬрд╛ рд╕рдХрддрд╛ рд╣реИред dotenv рд╣реЛрдиреЗ рдкрд░, рд╣рдо url/sampleUrl рдореЗрдВ рдкрд╛рд╕ рдХрд░ рд╕рдХрддреЗ рд╣реИрдВ рдЬрдм рд╣рдо docker рдХрдВрдЯреЗрдирд░ рдХреЛ рд╕реНрдЯрд╛рд░реНрдЯрдЕрдк рдХрд░рддреЗ рд╣реИрдВред

@ javajoe1 Dotenv рдПрдХ рдЕрдЪреНрдЫреЗ рд╡рд┐рдЪрд╛рд░ рдХреА рддрд░рд╣ рд▓рдЧрддрд╛ рд╣реИред рдХреГрдкрдпрд╛ рдЗрд╕ рд╕реБрд╡рд┐рдзрд╛ рдХреЗ рд▓рд┐рдП рдПрдХ рдкреАрдЖрд░ рдЬрдорд╛ рдХрд░рдиреЗ рдХреЗ рд▓рд┐рдП рд╕реНрд╡рддрдВрддреНрд░ рдорд╣рд╕реВрд╕ рдХрд░реЗрдВ :)

рдореБрдЭреЗ рд╣рдорд╛рд░реЗ рдПрдкреНрд▓рд┐рдХреЗрд╢рди рд╡рд╛рддрд╛рд╡рд░рдг рдХреЗ рдЕрдиреБрд╕рд╛рд░ рдирдореВрдирд╛ рдпреВрдЖрд░рдПрд▓ рдпрд╛ рдХрд┐рд╕реА рдЕрдиреНрдп рдПрдкрд┐рдбреЛрдЬрд╕рди рд╕реЗрдЯрд┐рдВрдЧ рдХреЛ рдирд┐рд░реНрджрд┐рд╖реНрдЯ рдХрд░рдиреЗ рдХрд╛ рд╕рдорд╛рдзрд╛рди рдорд┐рд▓рд╛ред
рдорд╛рди рд▓реАрдЬрд┐рдП рд╣рдорд╛рд░реЗ рдкрд╛рд╕ рдЪрд╛рд░ рдПрдирд╡реА рд╣реИрдВ - рд╕реНрдерд╛рдиреАрдп, рджреЗрд╡, рдордВрдЪ, рдЙрддреНрдкрд╛рдж
рдЗрди env рдХрд╛ рдЕрдкрдирд╛ рд╡рд┐рд╢рд┐рд╖реНрдЯ рдирдореВрдирд╛ рд╣реЛрдЧрд╛Url
рдмрд╕ рдПрдкрд┐рдбреЛрдХ рдмрдирд╛рдПрдВ-.json рдЗрди env рдХреЗ рд╕рдВрдмрдВрдз рдореЗрдВ рдЬреИрд╕реЗ-
рдПрдкрд┐рдбреЛрдХ-рд▓реЛрдХрд▓.рдЬреЗрд╕рди
рдПрдкрд┐рдбреЛрдХ-рджреЗрд╡.рдЬреЗрд╕рди
рдПрдкрд┐рдбреЛрдХ-рд╕реНрдЯреЗрдЬ.рдЬреЗрд╕рди
apidoc-prod.json
рдкреНрд░рддреНрдпреЗрдХ рдореЗрдВ рд╣рдо рдЙрдирдХреА рд╕рдВрдмрдВрдзрд┐рдд рд╕реЗрдЯрд┐рдВрдЧ рдирд┐рд░реНрджрд┐рд╖реНрдЯ рдХрд░рддреЗ рд╣реИрдВ
рдЕрдм рдмрд╕ рдПрдХ рдмреИрд╢ рд╕реНрдХреНрд░рд┐рдкреНрдЯ рд▓рд┐рдЦреЗрдВ рдЬреИрд╕реЗ apidoc.sh рдореЗрдВ рдирд┐рдореНрдирд▓рд┐рдЦрд┐рдд рдХреЛрдб рд╣реИ -

cp apidoc-$1.json apidoc.json
apidoc -f "./src/routes/.*\\.js$" -i ./ -o public/apidoc/
rm apidoc.json

рдЕрдм рд╣рд░ рдмрд╛рд░ рдЬрдм рдЖрдк рдХрд┐рд╕реА рднреА рдкрд░реНрдпрд╛рд╡рд░рдг рдХреЗ рд╕рд╛рде рдПрдкрд┐рдбреЛрдХ рдмрдирд╛рдирд╛ рдЪрд╛рд╣рддреЗ рд╣реИрдВ, рддреЛ рдЗрд╕реЗ рдирд┐рдореНрди рдЖрджреЗрд╢ рдХреЗ рд╕рд╛рде рдирд┐рд╖реНрдкрд╛рджрд┐рдд рдХрд░реЗрдВ -
sh ./apidoc.sh <env>
рдЙрджрд╛рд╣рд░рдг -

sh ./apidoc.sh dev 
sh ./apidoc.sh local

рдЗрд╕рдХреЗ рджреНрд╡рд╛рд░рд╛ рдпрд╣ рдЧрддрд┐рд╢реАрд▓ рд╡рд╛рддрд╛рд╡рд░рдг рдХреЗ рд╕рд╛рде рдПрдкрд┐рдбреЛрдХ рдмрдирд╛рдПрдЧрд╛ред

рдХреНрдпрд╛ рдпрд╣ рдкреГрд╖реНрда рдЙрдкрдпреЛрдЧреА рдерд╛?
0 / 5 - 0 рд░реЗрдЯрд┐рдВрдЧреНрд╕