blog

SpringBootをゼロからフルスタックモールswaggerインターフェースドキュメントの自動化へ

モールのバックエンド全体をゼロから実装するプロセスを文書化。...

Jan 7, 2021 · 3 min. read
シェア

紹介

SpringBootをゼロから記録し、モール全体のバックエンドプロセスを実現します。

プロジェクト・コンポーネントとテクノロジー・スタック

  • インターフェイスSpingBoot + JPA + mySql
  • バックエンドvue + vue-element-admin
  • モバイルuniapp + colorui + vuex + scss

備考

ビルドSpringBootプロジェクトは、直接プロジェクトの一般的な機能から、記録、swaggerドキュメントの自動化、jwtのユーザー認証を開始する導入されません

swaggerインターフェースドキュメントの自動化

pom依存関係のインポート

<dependency>
 	<groupId>io.springfox</groupId>
 	<artifactId>springfox-swagger2</artifactId>
 	<version>2.9.2</version>
</dependency>
<dependency>
	<groupId>com.github.xiaoymin</groupId>
 <artifactId>swagger-bootstrap-ui</artifactId>
 <version>1.8.2</version>
</dependency>

設定ファイルの作成

SwaggerConfig

package com.smxy.mall.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.ArrayList;
import java.util.List;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
 @Bean
 public Docket createRestApi() {
 return new Docket(DocumentationType.SWAGGER_2)
 .pathMapping("/")
 .globalOperationParameters(getGlobalOperationParameters()) //グローバルパラメータ
 .select()
 .apis(RequestHandlerSelectors.basePackage("com.smxy.mall.controller")) //プロジェクトの全コントローラをスキャンする
 .paths(PathSelectors.any())
 .build()
 .apiInfo(apiInfo());
 }
 private List<Parameter> getGlobalOperationParameters() {
 List<Parameter> pars = new ArrayList<>();
 ParameterBuilder parameterBuilder = new ParameterBuilder();
 // ヘッダーパラメータを追加し、テスト用にデフォルトトークンを追加する
 parameterBuilder.name("token")
 .defaultValue("eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0eXBlIjoiMiIsInVzZXJJZCI6MzIsInBob25lIjoiMTU3MTYwMjIzOTMiLCJzdWIiOiIzMiIsImlzcyI6IjA5OGY2YmNkNDYyMWQzNzNjYWRlNGU4MzI2MjdiNGY2IiwiaWF0IjoxNTk2MDgwODQ1LCJhdWQiOiJyZXN0YXBpdXNlciIsImV4cCI6MTU5NjY4NTY0NSwibmJmIjoxNTk2MDgwODQ1fQ.RaMy_L0Sa3UKFG7L7iDvmX47dAfrwEocQO7lJKDux8U")
 .modelRef(new ModelRef("string"))
 .parameterType("header")
 .required(false);
 pars.add(parameterBuilder.build());
 return pars;
 }
 private ApiInfo apiInfo() {
 return new ApiInfoBuilder()
 .title("インターフェースドキュメント")
 .description("springboot+vue")
 .version("1.0")
 .contact(new Contact("ハンサムブラッキー x","blog..net","aaa@gmail.com"))
 .license("The Apache License")
 .licenseUrl("http://..com")
 .build();
 }
}

訪問

プロジェクト・ポート+/doc.html 例:

Read next

Kubernetesチュートリアル:PIDからPod名を取得する

クラスタを管理する過程で、よくこのような状況に遭遇します。あるノードで、あるプロセスが高いリソースを使用していることがわかりますが、どのプロセスがどのコンテナに入っているのかわかりません。PIDに基づいてポッド名をすばやく見つける方法はありますか?仮にP

Jan 7, 2021 · 6 min read