rebirth http

@ng-zorro/重生-http

类似 Java JPA 的 Angular HTTP 客户端。

？安装

$ npm install @ng-zorro/rebirth-http --save

？用法

步骤1、注册RebirthHttpModule

 import { RebirthHttpModule } from '@ng-zorro/rebirth-http' ;

@ NgModule ( {
  imports : [ BrowserModule , RebirthHttpModule ] ,
  declarations : [ AppComponent ] ,
  bootstrap : [ AppComponent ] ,
} )
export class AppModule { }

第 2 步，创建 REST 客户端

 import {
  Any ,
  RebirthHttpClient ,
  JSONP ,
  GET ,
  POST ,
  PUT ,
  DELETE ,
  PATCH ,
  BaseUrl ,
  Query ,
  Path ,
  Body ,
} from 'rebirth-http' ;
import { Observable } from 'rxjs/Observable' ;
import { HttpClient } from '@angular/common/http' ;

@ Injectable ( )
export class ArticleService extends RebirthHttpClient {
  constructor ( http : HttpClient ) {
    super ( http ) ;
  }

  @ GET ( 'article' )
  getArticles (
    @ Query ( 'pageIndex' ) pageIndex = 1 ,
    @ Query ( 'pageSize' ) pageSize = 10
  ) : Observable < SearchResult < Article > > {
    return Any ; // return Any as a placeholder
  }

  @ GET ( 'article/:id' )
  getArticleByUrl ( @ Path ( 'id' ) articleUrl : string ) : Observable < Article > {
    return Any ;
  }

  @ POST ( 'article' )
  createArticle ( @ Body article : Article ) : Observable {
    return Any ;
  }

  @ PUT ( 'article/:id' )
  updateArticle (
    @ Path ( 'id' ) id : string ,
    @ Body article : Article
  ) : Observable < Article > {
    return Any ;
  }

  @ DELETE ( 'article/:id' )
  deleteArticleById ( @ Path ( 'id' ) id : string ) : Observable < Article > {
    return Any ;
  }

  @ JSONP ( 'article/:id' )
  getArticleByJsonp (
    @ Path ( 'id' ) id : string ,
    @ Query ( 'name' ) name : string
  ) : Observable < Article > {
    return Any ;
  }

  @ POST ( 'file/upload' )
  upload ( @ Body formData : FormData ) : Observable < any > {
    return Any ;
  }
}

第三步，调用ArticleService

现在您可以调用ArticleService的方法来触发 HTTP 请求！ :)

拦截器

您可以为任何RebirthHttpClient添加拦截器。

 import { config } from '@/config' ;
import { RebirthHttpProvider } from '@ng-zorro/rebirth-http' ;

@ Component ( {
  selector : 'app-root' ,
} )
export class AppComponent {
  constructor ( rebirthHttpProvider : RebirthHttpProvider ) {
    rebirthHttpProvider . baseUrl ( config . api . host ) . addInterceptor ( {
      request : ( request ) =>
        console . log ( 'Global interceptors(request)' , request ) ,
      response : ( response ) =>
        console . log ( 'Global interceptors(response)' , response ) ,
    } ) ;
  }
} 

应用程序编程接口

RebirthHttpClient

每个负责 HTTP 的服务都应该继承RebirthHttpClient 。

• getBaseUrl(): string : 返回 RebirthHttp 客户端的基本 url
• getDefaultHeaders(): { [name: string]: string } ：以键值对形式返回 RebirthHttp 的默认标头

类装饰器

这些装饰器应该用在继承RebirthHttpClient的类上。

• @BaseUrl(url: string) ：更改 RebirthHttpClient 的基本 url
• @DefaultHeaders(headers: Object) ：更改 RebirthHttpClient 的默认标头

方法装饰器

HTTP 方法装饰器

这些装饰器将使RebirthHttpClient的方法能够发送 HTTP 请求。

• @GET(url: string)
• @POST(url: string)
• @PUT(url: string)
• @DELETE(url: string)
• @JSONP(url: string)
• @PATCH(url: string)
• @HEAD(url: string)
• @OPTIONS(url: String)

您可以使用下面的装饰器来修改 HTTP 选项。

• @Headers(headers: any)
• @RequestOptions(headers: any)
• @Extra(headers: any)

参数装饰器

使用下面的装饰器来装饰RebirthHttpClient方法的参数，使参数成为相应的 HTTP 选项。

• @Path(key: string)
• @Query(key: string)
• @Header(key: string)
• @Body

信用

感谢Paldom/angular2-rest给我们的灵感。

☀️ 许可证

麻省理工学院