ea502dd9.c43aa12e.js

(window.webpackJsonp=window.webpackJsonp||[]).push([[19],{122:function(e,t,o){"use strict";o.r(t),o.d(t,"frontMatter",(function(){return r})),o.d(t,"metadata",(function(){return p})),o.d(t,"rightToc",(function(){return c})),o.d(t,"default",(function(){return l}));var a=o(1),n=o(6),i=(o(0),o(136)),r={id:"welcome",title:"Initial commit",author:"TomRiddle",author_title:"Maintainer of Api4p",author_image_url:"https://4programmers.net/uploads/photo/4f75757c99c83.png",tags:["api"]},p={permalink:"/api-4p/blog/welcome",source:"@site/blog\\2020-03-31-welcome.md",description:"Witam wszystkich.\r",date:"2020-03-31T00:00:00.000Z",tags:[{label:"api",permalink:"/api-4p/blog/tags/api"}],title:"Initial commit",truncated:!0},c=[],m={rightToc:c};function l(e){var t=e.components,o=Object(n.a)(e,["components"]);return Object(i.b)("wrapper",Object(a.a)({},m,o,{components:t,mdxType:"MDXLayout"}),Object(i.b)("p",null,"Witam wszystkich."),Object(i.b)("p",null,"Stworzy\u0142em w\u0142asnie ten o to projekcik, \u017ceby by\u0142a pewna alternatywa dla dokumentacji swaggerowej dla ",Object(i.b)("a",Object(a.a)({parentName:"p"},{href:"https://4programmers.net"}),"4programmers.net"),'.\nWi\u0119cej w "Read more".'),Object(i.b)("p",null,"Doda\u0142bym tylko, \u017ce sam pracowa\u0142em wielokrotnie z dokumentacjami typu Swagger - czyli takimi kt\xf3re generuj\u0105 wpis w\ndokumentacji nt controllera w relacji 1:1 - ",Object(i.b)("inlineCode",{parentName:"p"},"AuthController")," z metodami ",Object(i.b)("inlineCode",{parentName:"p"},"login"),"/",Object(i.b)("inlineCode",{parentName:"p"},"logout")," generuje 2 wpisy:\n",Object(i.b)("inlineCode",{parentName:"p"},"login")," oraz ",Object(i.b)("inlineCode",{parentName:"p"},"logout"),". "),Object(i.b)("p",null,"Mia\u0142o to taki efekt, \u017ce albo dokumentacj\u0105 by\u0142o jedno zdanie w banalny spos\xf3b opisuj\u0105cy endpoint:\n(np. ",Object(i.b)("inlineCode",{parentName:"p"},"Fetches a user by id")," pod endpointem ",Object(i.b)("inlineCode",{parentName:"p"},"/users/:id"),'), albo dokumentacja rozrasta\u0142a si\u0119 w bardzo horyzontalny spos\xf3b,\ntzn. ma\u0142o/dosy\u0107 szczeg\xf3\u0142owe opisy jednostek (np. zasob\xf3w), przy jednoczesnym praku opisu "wi\u0119kszego obrazka".'),Object(i.b)("p",null,"Pomy\u015bla\u0142em wi\u0119c \u017ce stworz\u0119 tak\u0105 pr\xf3b\u0119 lepszego dokumentowania API dla ",Object(i.b)("a",Object(a.a)({parentName:"p"},{href:"https://4programmers.net"}),"4programmers.net"),", i kto wie, mo\u017ce co\u015b z tego b\u0119dzie? :)"))}l.isMDXComponent=!0}}]);