lasta-docからlasta-metaへの移行

概要

LastaDocやswagger.jsonを生成するライブラリとしてlasta-docを提供していましたが、lasta-metaという名前に変更されました。(2021年)

今後は、lasta-metaとしてリリースしていきますので、移行をお願いします。

移行しなくても良いケース

lasta-docライブラリに明示的な依存をせず、かつ、Swaggerも使っていない場合は、(おそらく)移行作業は必要ありません。 (harborやmaihama-docksideのようなアプリの場合)

明示的な依存をしていない場合は、UTFlute経由で依存をしていることになりますので、UTFluteをアップグレードしたら自然と移行されます。

※UTFluteは、バージョン 0.9.2 より lasta-meta を参照しています。

1. MavenやGradleの設定

groupId と artifactId などが変わっています。

groupId
org.lastaflute.doc → org.lastaflute.meta
artifactId
lasta-doc → lasta-meta
version
0.3.7 (これにてstop)0.5.x (最新を指定しましょう)

2. Swaggerクラスでimportし直し

lasta-metaのクラスはすべてパッケージが変わっていますので、そのままライブラリを差し替えるとSwaggerActionなどでコンパイルエラーになるはずです。

ただ、クラス名自体は変わってないので、コンパイルエラーになったクラスはimportし直すことで移行ができます。

3. UTFluteを最新版に

UTFluteは、バージョン 0.9.2 より lasta-meta を参照しています。UTFluteを最新版にアップグレードお願いします。 (古いバージョンのままだと lasta-doc が混在してしまって、同名別クラスでコンパイルエラーになってしまいます)

逆に、UTFluteを最新版にしたら、lasta-metaの移行も必須になります。

LastaDocと言うと?

今後「らすたどっく」と言うと、自動生成されたHTMLのドキュメントのLastaDocを指します。

今までそこが曖昧になってしまい、会話がしづらい問題がありました。