『ニャーニャー大』サーバー開発日記-2(Swaggerアプリ)

日記の始まりは近況から…。

第1編を書いてからずいぶん時間が経った.
私は2月初めに中小企業のバックエンド開発者として就職しました.🥰
誰もが知っている有名なN社K社C社ではありませんが満足して出勤ほほほ

就職はかなり忙しいと思っていましたが、思ったより余裕がありました.私の任務を完成した後、私は勉強したいことをすることができて嬉しいです.今までもそうだった.

その後、就職を喜ぶ気持ちでmacbookproに参加しました.分割払いは来年の私が最後に払うべきでしょう...

第1篇で言えなかった内容..。

当時maven packageにエラーがあり、行われませんでした.その後検査を続けたところ、jdkは互いに衝突し、実行できないことが分かった.以降のバージョンに合わせてclean-packageを行い、正常に動作します.
その後,構築されたjdkに対してもEC 2は同じバージョンの構築を行った.

今どうやってテストすればいいですか?

就職してからしばらく会ったことがないので、しばらく会社のプロジェクトに集中しています.でも余裕が出てきて、さらにスプリングの魅力にはまりました.
これでEC 2にアップロードされ、機能の追加を続けるたびにテストが行われます.
system.out.println()で印刷テストを行う方法はもうできません.
いろいろな方法がありますが、最初はPostManを使ってテストしていました.
APIは引き続き大きくなり、API Docsが必要になるに違いないので、一番よく知っていて、GUIは満足しています.

良いツールを選びましたが、一番気分が悪いのは、手動で追加し続ける手間です.
だから熟考して傲慢を選んだ.

実際に使ってみると、長所は確かにあるようだ.
長所

便

簡潔

短所

説明を追加し続ける必要があるため、コードは徐々に長くなる

自分でやろう

まず依存性を追加!

        <!--Spring swagger2-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>3.0.0</version>
        </dependency>

3.0.0でこのセクションを追加しても、エラーは発生しません.
念のため申請しなければならない.ymlに追加(アプリケーション.xml、アプリケーション.propertiesなど...)

spring:
    mvc:
      pathmatch:
        matching-strategy: ant_path_matcher

次に、新しい構成フォルダを作成し、SwaggerConfigurationを作成します.

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


@Configuration
@EnableSwagger2
public class SwaggerConfiguration {
    @Bean
    public Docket swaggerApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.nyanyumserver.nyanyumserver"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("NYU API")
                .description("USER")
                .version("1.0.0")
                .build();
    }
}

書き終わったら、今すぐコントローラに適用します.

まず、Controllerを適用するEnableSwagger2に追加する

上記のコードのように、@ApiOperationを追加し、valueの値も追加します.
@ApiOperationのvalue値が適用されると、このような状況が発生します.@ApiParamパラメータ値の名前を指定します.
属性値はrequiredで、拡大した後に値を入れなければ操作できません.
@ApiIgnoreは、表示されないパラメータを非表示にする機能を有する.それを示す必要がないので、セッションを適用しました.
もしすべて適用されたら、今確認してみましょう.
Swager 3.0.0からは、次のようなリンクで接続する必要があります.

http://localhost:{port}/swagger-ui/index.html#/

{port}プロジェクトのポート番号を入れればいいです.
次のようにリンクで接続します.

ポスト

誇張を適用した後、フロントでテストするときに便利だと言われています.テストするのも便利だし、いろいろな機能の一つだと思うので気持ちがいいです.