JS 注释的写法，配合Swagger

  

   

    

     

    
    

     
 /**
     
    
   

    

     

    
    

     

       * @summary 接口的描述
     
    
   

    

     

    
    

     

       * @token
     
    
   

    

     

    
    

     

       * @router GET /user/v1/info/{id}
     
    
   

    

     

    
    

     

       * @request path number id eg:1 用户id
     
    
   

    

     

    
    

     

       * @response 200 user_vo UserVO
     
    
   

    

     

    
    

     

       */
     
    
  
 

  

   

    

     

    
    

     

      /**
     
    
   

    

     

    
    

     

       * @summary 接口描述
     
    
   

    

     

    
    

     

       * @token
     
    
   

    

     

    
    

     

       * @router GET /user/query
     
    
   

    

     

    
    

     

       * @request query string keyword 关键字
     
    
   

    

     

    
    

     

       * @response 200
     
    
   

    

     

    
    

     

       */
     
    
  
 

  

   

    

     

    
    

     

      /** 
     
    
   

    

     

    
    

     

       * 使用关键词查询
     
    
   

    

     

    
    

     

       * @param {string} keyword
     
    
   

    

     

    
    

     

       */
     
    
  
 

文章来源: fizzz.blog.csdn.net，作者：拿我格子衫来，版权归原作者所有，如需转载，请联系作者。

原文链接：fizzz.blog.csdn.net/article/details/108378592