Skip to content

在编写api文件时需要注意一些点,以免造成困扰,在这里记录一下,具体的教程官方有,很好理解

在引入其他的api文件时

有时候写的api文件会很大,而且很多重复的内容,我们需要对其他的包的内容进行引用,以减少冗余的内容,减少单个文件的长度,以免过长

  • animals.api
  • love-nest.api
  • model.api
  • user.api

以上时四个api文件,model定义了一些实体,有许多场景会进行复用,所有抽象出来,放到一个文件,animals和user时定义了相关的请求体和返回体,还有相关的service,然后在love-nest.api中引用animals和user,然后通过love-nest生成代码

以上时是说明,下面说一下注意事项:

  • animals和user里面的service的名字需要相同,不然会报错
  • 在model中定义的类型需要首字母大写,因为在生成代码过程中,如果是类型首字母小写的话在转换成代码的是否会转换成大写,然而有一些情况引用他的一些文件中,生成的代码会是还是小写,这个应该是一个Bug,所以说最好就是一直首字母大写最好
  • 不能循环引用,比如说A引用了B,B又去引用A