controller发布为rest api


将写好的controller发布为rest api,并且可以看到各个方法的解释?

1.在Controller类上配置

 @Rest
 @At("/your/service/path")
 @Ok("jackson:rest")
 @Fail("jackson:rest")
 @AccessRestrict(permissions = "...")
 @IocBean
 @InjectName
 @AdaptBy(type = JsonAdaptor.class)

2.在每一个想要发布为接口的方法上配置

 @At
 @GET/@POST
 @Log(key="...", bundle="...")

  • @At可以根据自己的需要配置,但不可省略
  • @GET@POST必须配置,并应该根据接口的实际功能来选择
  • @Log建议都进行配置

3.在接口方法的参数上配置@Param注解

 

注解:

@REST:直接应用于类上,表明此类中全部或绝大多数的方法都要发布为REST接口,对少数不发布的方法,则在方法上再配置此注解并设置{@link #enable()}为false

    默认plain=false,表示不想同时发布为Controller,只发布为Web Service;如果想同时发布为Controller,应该设置plain=true,即@REST(plain=true)

相关