[B! swagger] hibinotatsuyaã®ãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯

hibinotatsuya id:hibinotatsuya

swaggerã«é–¢ã™ã‚‹hibinotatsuyaã®ãƒ–ãƒƒã‚¯ãƒžãƒ¼ã‚¯ (5)

${{author_name}}$

{{{comment_expanded}}}

{{label}}

{{#is_bookmark}}ãƒªã‚¹ãƒˆ{{/is_bookmark}}{{^is_bookmark}}ãƒªãƒ³ã‚¯{{/is_bookmark}}

${{author_name}}$
{{author_name}}{{created}}
{{ #comment }}{{ comment }}{{ /comment }}
- {{ label }}

${{author_name}}$

{{{comment_expanded}}}

{{label}}

{{#is_bookmark}}ãƒªã‚¹ãƒˆ{{/is_bookmark}}{{^is_bookmark}}ãƒªãƒ³ã‚¯{{/is_bookmark}}

VScodeã§OpenAPIã‚’æ›¸ããŸã‚ã«ä¾¿åˆ©ãªãƒ—ãƒ©ã‚°ã‚¤ãƒ³ä¸€è¦§
ã¯ã˜ã‚ã« é–‹ã„ã¦ã„ãŸã ãã‚ã‚ŠãŒã¨ã†ã”ã–ã„ã¾ã™ã€‚ OpenAPIã‚’æ›¸ãéš›ã¯ã“ã‚Œã¾ã§ãƒ–ãƒ©ã‚¦ã‚¶ä¸Šã®ã€ŒSwagger Editorã€ã‚’ä½¿ç”¨ã—ã¦ã„ã¾ã—ãŸã€‚ ãƒ—ãƒ©ã‚°ã‚¤ãƒ³ã‚’å…¥ã‚Œã‚‹ã“ã¨ã§VScodeã§ã‚‚æ›¸ã‘ã‚‹ã“ã¨ãŒã‚ã‹ã£ãŸ(ãŠãã‚‰ãä»Šå¾Œã¯å…¨éƒ¨VScodeã§æ›¸ãã“ã¨ã«ãªã‚‹ã‚“ã ã‚ã†ãªãƒ»ãƒ»ãƒ»)ã®ã§ã€ãã®éš›ã«ä½¿ç”¨ã—ãŸãƒ—ãƒ©ã‚°ã‚¤ãƒ³ã‚’ã¾ã¨ã‚ã¦ã¿ã‚ˆã†ã¨æ€ã„ã¾ã™ã€‚ ãƒ—ãƒ©ã‚°ã‚¤ãƒ³ Swagger Viewer viewerã‚’é–‹ãã«ã¯ä»¥ä¸‹ã®æ–¹æ³•ã§è¡Œã„ã¾ã™ã€‚ ã‚³ãƒžãƒ³ãƒ‰ãƒ‘ãƒ¬ãƒƒãƒˆã‹ã‚‰ã€ŒPreview Swaggerã€ã‚’é¸æŠž shift + option + p ä»¥ä¸‹ã®ã‚ˆã†ã«Swagger Editorã¨åŒã˜ç”»é¢ã§ç¢ºèªã™ã‚‹ã“ã¨ãŒã§ãã¾ã™ã€‚ ã¾ãŸã€ç·¨é›†ã¯ãƒªã‚¢ãƒ«ã‚¿ã‚¤ãƒ ã§æ›´æ–°ã•ã‚Œã¾ã™ã€‚ openapi-lint openAPIã®ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆã‚’æ¤œè¨¼ã‚„é™çš„è§£æžã‚’è¡Œã£ã¦ãã‚Œã‚‹æ‹¡å¼µæ©Ÿèƒ½ã§ã™ã€‚ OpenAPI(Swagger) Editor ã‚¨ã‚¯ã‚¹ãƒ—ãƒ
hibinotatsuya 2023/03/31
swagger
ãƒªãƒ³ã‚¯
Laravelã§Swaggerã‚’è‡ªå‹•ç”Ÿæˆã™ã‚‹ - Qiita
<?php namespace App\Http\Controllers; use App\Services\TestService; use Illuminate\Http\Request; /** * @OA\Info( * version="1.0.0", * title="Swagger", * description="", * ) */ class TestController extends Controller { ãƒ»ãƒ»ãƒ»ä»¥ä¸‹ç•¥ãƒ»ãƒ»ãƒ» @OA\Get methodï¼ˆPOST, GET, PUT, DELETEï¼‰ã‚’æŒ‡å®šã™ã‚‹ã€‚ tags swaggerã®åˆ†é¡žã‚’è¨å®šã™ã‚‹ã€‚ä¾‹ãˆã°ãƒ¦ãƒ¼ã‚¶ãƒ¼é–¢é€£ã®APIãªã‚‰Userãªã©ã€‚ summary ã‚¢ã‚³ãƒ¼ãƒ‡ã‚£ã‚ªãƒ³ã‚’é–‰ã˜ã¦ã„ã¦ã‚‚è¦‹ãˆã‚‹èª¬æ˜Žæ–‡ description ã‚¢ã‚³ãƒ¼ãƒ‡ã‚£ã‚ªãƒ³ã‚’é–‹ãã¨è¦‹ãˆã‚‹èª¬æ˜Žæ–‡ @OA\RequestBody ãƒªã‚¯ã‚¨ã‚¹ãƒˆå€¤ã‚’è¨
hibinotatsuya 2021/07/15
Laravel

swagger
ãƒªãƒ³ã‚¯
Laravelã®l5-swaggerã§ã€OpenAPIè¨˜æ³•ã§multipart/form-dataã‚’è¡¨ç¤ºã™ã‚‹ - Qiita
Laravelã®l5-swaggerã§ã€OpenAPIè¨˜æ³•ã§multipart/form-dataã‚’è¡¨ç¤ºã™ã‚‹Laravel OpenAPI ã¯ã˜ã‚ã« Laravelã®l5-swaggerã§APIãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆå…¼APIå‹•ä½œç¢ºèªã‚’è¡Œã†éš›ã«ã€multipart/form-dataå½¢å¼ã§ã®swaggerã‚’ä½œæˆã™ã‚‹æ–¹æ³•ã€‚ TL; DR; RequestBody ã® MediaType ã§ mediaType="multipart/form-data"ã‚’æŒ‡å®šã™ã‚‹ã€‚ Schema ã® Property ã§é …ç›®ã‚’åˆ—æŒ™ã™ã‚‹ è¨˜è¼‰æ–¹æ³• /** * * @OA\Post( * path="/sample", * operationId="multipart sample", * @OA\RequestBody( * @OA\MediaType( * mediaType="multipart/form-data",/
hibinotatsuya 2021/02/05
swagger
ãƒªãƒ³ã‚¯
L5-Swaggerã‚’ä½¿ã£ã¦OpenAPIãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆã‚’ä½œæˆã™ã‚‹
ï¼œ?php namespace App\Http\Controllers; /** * @OA\Info( * version="1.0.0", * title="L5-Swaggerã‚µãƒ³ãƒ—ãƒ«", * description="ã‚µãƒ³ãƒ—ãƒ«", * ) */ class HelloController extends Controller { /** * @OA\Get( * path="/hello", * operationId="hello", * tags={"ã‚¿ã‚°"}, * summary="ãƒãƒãƒ¼", * description="ã“ã‚“ã«ã¡ã¯", * @OA\Response( * response=200, * description="æˆåŠŸ", * @OA\JsonContent( * type="object", * @OA\Property( * property="mes
hibinotatsuya 2021/02/05
Laravel

swagger
ãƒªãƒ³ã‚¯
Swaggerã®æ¦‚è¦ã‚’ã¾ã¨ã‚ã¦ã¿ãŸã€‚ - Qiita
æ¦‚è¦ æœ€è¿‘ã¯ API Blueprint ã§ä»•æ§˜æ›¸ã‚’æ›¸ãã“ã¨ãŒå¤šã‹ã£ãŸã®ã§ã™ãŒã€Swagger ãŒä¸–ç•Œæ¨™æº–ã«ãªã‚‹ã‹ã‚‚ã—ã‚Œãªã„ã€ã¨ã„ã†ã“ã¨ã‚‚ã‚ã‚Šã€é–‹ç™ºã®åŠ¹çŽ‡åŒ–ã‚’é€²ã‚ã‚‹ãŸã‚ã«ã‚‚æ¦‚è¦ã‚’ã¾ã¨ã‚ã¦ã¿ã‚ˆã†ã¨æ€ã£ãŸæ¬¡ç¬¬ã§ã™ã€‚ Swaggerã¨ã¯ Swagger ã¯ RESTful APIã‚’æ§‹ç¯‰ã™ã‚‹ãŸã‚ã®ã‚ªãƒ¼ãƒ—ãƒ³ã‚½ãƒ¼ã‚¹ã®ãƒ•ãƒ¬ãƒ¼ãƒ ãƒ¯ãƒ¼ã‚¯ã®ã“ã¨ã§ã™ã€‚ã€ŒOpen API Initiativeã€ã¨ã„ã†å›£ä½“ãŒRESTful APIã®ã‚¤ãƒ³ã‚¿ãƒ¼ãƒ•ã‚§ã‚¤ã‚¹ã®è¨˜è¿°ã‚’ã™ã‚‹ãŸã‚ã®æ¨™æº–ãƒ•ã‚©ãƒ¼ãƒžãƒƒãƒˆã‚’æŽ¨é€²ã—ã¦ã„ã¦ã€ãã®æ¨™æº–ãƒ•ã‚©ãƒ¼ãƒžãƒƒãƒˆãŒSwaggerã§ã™ã€‚Swaggerã«ã¯å¤šãã®ä¾¿åˆ©ãªãƒ„ãƒ¼ãƒ«ãŒæä¾›ã•ã‚Œã¦ã„ã‚‹ã“ã¨ã‚‚ã‚ã‚Šã€å¤šãã®ãƒ¡ãƒªãƒƒãƒˆã‚’äº«å—ã§ããã†ã§ã™ã€‚ Swagger Spec ã‚’æ›¸ã„ã¦ãŠã‘ã°è‡ªå‹•çš„ã«ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆç”Ÿæˆã¾ã§ã—ã¦ãã‚Œã€ãã‚Œã ã‘ã§ã¯ãªãã€ãƒ‰ã‚ãƒ¥ãƒ¡ãƒ³ãƒˆã‹ã‚‰å®Ÿéš›ã®ãƒªã‚¯ã‚¨ã‚¹ãƒˆã‚’æŠ•ã’ã‚‰ã‚Œã‚‹å„ªã‚Œã‚‚ã®ã§ã™ã€‚ Swaggerã®ãƒ„ãƒ¼ãƒ«ç¾¤
hibinotatsuya 2021/02/05
api

swagger
ãƒªãƒ³ã‚¯
1