質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

新規登録して質問してみよう
ただいま回答率
85.48%
Swagger

Swaggerは、REST APIを定義するための標準仕様に基づいて構築された一連のオープンソースツール。REST APIの設計や構築、文書化、使用に便利なツールを提供。Swagger Specを書くことでドキュメント生成まで自動的に行い、さらにドキュメントから実際のリクエストを投げられます。

Java

Javaは、1995年にサン・マイクロシステムズが開発したプログラミング言語です。表記法はC言語に似ていますが、既存のプログラミング言語の短所を踏まえていちから設計されており、最初からオブジェクト指向性を備えてデザインされています。セキュリティ面が強力であることや、ネットワーク環境での利用に向いていることが特徴です。Javaで作られたソフトウェアは基本的にいかなるプラットフォームでも作動します。

Spring

Spring Framework は、Javaプラットフォーム向けのオープンソースアプリケーションフレームワークです。 Java Platform上に、 Web ベースのアプリケーションを設計するための拡張機能が数多く用意されています。

Q&A

解決済

1回答

835閲覧

Swaggerで生成されるControllerが動かない

bobo

総合スコア40

Swagger

Swaggerは、REST APIを定義するための標準仕様に基づいて構築された一連のオープンソースツール。REST APIの設計や構築、文書化、使用に便利なツールを提供。Swagger Specを書くことでドキュメント生成まで自動的に行い、さらにドキュメントから実際のリクエストを投げられます。

Java

Javaは、1995年にサン・マイクロシステムズが開発したプログラミング言語です。表記法はC言語に似ていますが、既存のプログラミング言語の短所を踏まえていちから設計されており、最初からオブジェクト指向性を備えてデザインされています。セキュリティ面が強力であることや、ネットワーク環境での利用に向いていることが特徴です。Javaで作られたソフトウェアは基本的にいかなるプラットフォームでも作動します。

Spring

Spring Framework は、Javaプラットフォーム向けのオープンソースアプリケーションフレームワークです。 Java Platform上に、 Web ベースのアプリケーションを設計するための拡張機能が数多く用意されています。

0グッド

0クリップ

投稿2022/09/06 00:35

前提

こんにちは。
SpringでWEBシステムを作っています。
Swagger(openAPI)で生成したものを組み込んでいます。

ただ、手動で作成したControllerはURLを叩けばブレークポイントが止まるのですが、
Swaggerで生成されるControllerは止まりません。

手動で作成したものは@RestControllerに対し、Swaggerが生成した者は@Apiで書き出されてますが、混同していてはいけないのでしょうか?
いずれはSwaggerで生成される物を是とし、手動作成したControllerは破棄の予定です。

実現したいこと

Swaggerで生成されるControllerも正常に通る様にしたい。

発生している問題・エラーメッセージ

ブレークポイントを当てても入って来ず、Exceptionでエラーを起こしている形跡もありません。

該当のソースコード

Java

1// Swaggerで生成したControllerクラス 2@javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.SpringCodegen", date = "") 3@Api(value = "Echo", description = "the Echo API") 4public interface EchoApi { 5 6 Logger log = LoggerFactory.getLogger(EchoApi.class); 7 8 default Optional<ObjectMapper> getObjectMapper(){ 9 return Optional.empty(); 10 } 11 12 default Optional<HttpServletRequest> getRequest(){ 13 return Optional.empty(); 14 } 15 16 default Optional<String> getAcceptHeader() { 17 return getRequest().map(r -> r.getHeader("Accept")); 18 } 19 20 @ApiOperation(value = "Echo処理", nickname = "echoPost", notes = "Helloを返却する", response = EchoReply.class, tags={ "echo", }) 21 @ApiResponses(value = { 22 @ApiResponse(code = 200, message = "成功", response = EchoReply.class) }) 23 @RequestMapping(value = "/echo", 24 produces = { "application/json" }, 25 consumes = { "application/json" }, 26 method = RequestMethod.POST) 27 default ResponseEntity<EchoReply> echoPost(@ApiParam(value = "" ,required=true ) @Valid @RequestBody EchoRequest body 28) { 29 if(getObjectMapper().isPresent() && getAcceptHeader().isPresent()) { 30 if (getAcceptHeader().get().contains("application/json")) { 31 try { 32 return new ResponseEntity<>(getObjectMapper().get().readValue("{\r\n \"name\" : \"Hello\"\r\n}", EchoReply.class), HttpStatus.NOT_IMPLEMENTED); 33 } catch (IOException e) { 34 log.error("Couldn't serialize response for content type application/json", e); 35 return new ResponseEntity<>(HttpStatus.INTERNAL_SERVER_ERROR); 36 } 37 } 38 } else { 39 log.warn("ObjectMapper or HttpServletRequest not configured in default EchoApi interface so no example is generated"); 40 } 41 return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); 42 } 43 44} 45 46//手動作成したControllerクラス 47@RestController 48public class TestController { 49 @Autowired 50 private TestService service; 51 52 // curl -v 'http://localhost:8080/test?name=test' 53 @GetMapping("/test") 54 public JsonResult execute_a(@Validated TestForm form, BindingResult validate) throws JsonProcessingException { 55 JsonResult result = new JsonResult(); 56 if (validate.hasErrors()) { 57 result.setResult("error"); 58 result.setErrors(getValidationErrorMessage(validate)); 59 return result; 60 } 61 result.setResult(service.execute(form)); 62 return result; 63 }

試したこと

両方のURLをcurlコマンドで実行した。
curl -v 'http://localhost:8080/test?name=test'
curl -i -X POST -H "Content-Type: application/json" -d "@c:/request.json" http://localhost:8080/echo

補足情報(FW/ツールのバージョンなど)

Java1.8
Spring
Swagger3.0.19

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

guest

回答1

0

自己解決

失礼しました。APIClassは出力されてもControllerクラスは自作しない(APIをimplementsしてOverride)といけないのですね。
解決しました。

投稿2022/09/06 05:27

bobo

総合スコア40

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.48%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問