Difference between revisions of "REST"

From Dogtag
Jump to: navigation, search
m (References)
m
 
(14 intermediate revisions by the same user not shown)
Line 1: Line 1:
= Overview =
+
= Frameworks =
  
PKI provides REST interfaces to allow clients to access services on the server. The REST services are implemented using [[RESTEasy]].
+
* [[RESTEasy]]
 
+
* [[Jersey]]
= REST API =
+
* [[CXF]]
 
 
The PKI REST API are defined in the following Resource classes. These classes define the paths, the operations, the parameters, the authentications, and the responses of the REST resources. See [[RESTEasy]].
 
 
 
* [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/account com.netscape.certsrv.account]
 
** [http://git.fedorahosted.org/cgit/pki.git/plain/base/common/src/com/netscape/certsrv/account/AccountResource.java AccountResource]
 
  
* [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/authority com.netscape.certsrv.authority]
+
= PKI REST API =
** [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/authority/AuthorityResource.java AuthorityResource]
 
  
* [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/cert com.netscape.certsrv.cert]
+
See [https://github.com/dogtagpki/pki/wiki/PKI-REST-API-Design PKI REST API Design].
** [http://git.fedorahosted.org/cgit/pki.git/plain/base/common/src/com/netscape/certsrv/cert/CertResource.java CertResource]
 
** [http://git.fedorahosted.org/cgit/pki.git/plain/base/common/src/com/netscape/certsrv/cert/CertRequestResource.java CertRequestResource]
 
 
 
* [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/group com.netscape.certsrv.group]
 
** [http://git.fedorahosted.org/cgit/pki.git/plain/base/common/src/com/netscape/certsrv/group/GroupResource.java GroupResource]
 
 
 
* [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/key com.netscape.certsrv.key]
 
** [http://git.fedorahosted.org/cgit/pki.git/plain/base/common/src/com/netscape/certsrv/key/KeyResource.java KeyResource]
 
** [http://git.fedorahosted.org/cgit/pki.git/plain/base/common/src/com/netscape/certsrv/key/KeyRequestResource.java KeyRequestResource]
 
 
 
* [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/logging com.netscape.certsrv.logging]
 
** [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/logging/AuditResource.java AuditResource]
 
** [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/logging/ActivityResource.java ActivityResource]
 
 
 
* [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/profile com.netscape.certsrv.profile]
 
** [http://git.fedorahosted.org/cgit/pki.git/plain/base/common/src/com/netscape/certsrv/profile/ProfileResource.java ProfileResource]
 
 
 
* [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/selftests com.netscape.certsrv.selftests]
 
** [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/selftests/SelfTestResource.java SelfTestResource]
 
 
 
* [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/system  com.netscape.certsrv.system]
 
** [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/system/FeatureResource.java FeatureResource]
 
** [http://git.fedorahosted.org/cgit/pki.git/plain/base/common/src/com/netscape/certsrv/system/KRAConnectorResource.java KRAConnectorResource]
 
** [http://git.fedorahosted.org/cgit/pki.git/plain/base/common/src/com/netscape/certsrv/system/SecurityDomainResource.java SecurityDomainResource]
 
** [http://git.fedorahosted.org/cgit/pki.git/plain/base/common/src/com/netscape/certsrv/system/SystemCertResource.java SystemCertResource]
 
** [http://git.fedorahosted.org/cgit/pki.git/plain/base/common/src/com/netscape/certsrv/system/SystemConfigResource.java SystemConfigResource]
 
** [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/system/TPSConnectorResource.java TPSConnectorResource]
 
 
 
* [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/tps/authenticator com.netscape.certsrv.tps.authenticator]
 
** [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/tps/authenticator/AuthenticatorResource.java AuthenticatorResource]
 
 
 
* [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/tps/cert com.netscape.certsrv.tps.cert]
 
** [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/tps/cert/TPSCertResource.java TPSCertResource]
 
 
 
* [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/tps/config com.netscape.certsrv.tps.config]
 
** [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/tps/config/ConfigResource.java ConfigResource.java]
 
 
 
* [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/tps/connector com.netscape.certsrv.tps.connector]
 
** [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/tps/connector/ConnectorResource.java ConnectorResource]
 
 
 
* [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/tps/profile com.netscape.certsrv.tps.profile]
 
** [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/tps/profile/ProfileResource.java ProfileResource]
 
** [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/tps/profile/ProfileMappingResource.java ProfileMappingResource]
 
 
 
* [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/tps/token com.netscape.certsrv.tps.token]
 
** [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/tps/token/TokenResource.java TokenResource]
 
 
 
* [http://git.fedorahosted.org/cgit/pki.git/tree/base/common/src/com/netscape/certsrv/user com.netscape.certsrv.user]
 
** [http://git.fedorahosted.org/cgit/pki.git/plain/base/common/src/com/netscape/certsrv/user/UserResource.java UserResource]
 
 
 
= REST Services =
 
 
 
The REST services that are running in each subsystem are defined in the following Application classes.  See [[RESTEasy]].
 
 
 
* [http://git.fedorahosted.org/cgit/pki.git/tree/base/ca/src/org/dogtagpki/server/ca/rest/CAApplication.java org.dogtagpki.server.ca.rest.CAApplication]
 
* [http://git.fedorahosted.org/cgit/pki.git/tree/base/kra/src/org/dogtagpki/server/kra/rest/KRAApplication.java org.dogtagpki.server.kra.rest.KRAApplication]
 
* [http://git.fedorahosted.org/cgit/pki.git/tree/base/ocsp/src/org/dogtagpki/server/ocsp/rest/OCSPApplication.java org.dogtagpki.server.ocsp.rest.OCSPApplication]
 
* [http://git.fedorahosted.org/cgit/pki.git/tree/base/tks/src/org/dogtagpki/server/tks/rest/TKSApplication.java org.dogtagpki.server.tks.rest.TKSApplication]
 
* [http://git.fedorahosted.org/cgit/pki.git/tree/base/tps/src/org/dogtagpki/server/tps/rest/TPSApplication.java org.dogtagpki.server.tps.rest.TPSApplication]
 
  
 
= References =
 
= References =
  
* [[RESTEasy]]
+
* [https://www.gajotres.net/best-available-java-restful-micro-frameworks/ Top 8 Java RESTful Micro Frameworks – Pros/Cons]
* [[REST API Design]]
+
* [https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html RFC 2616: Header Field Definitions]
* [[PKI Client API Design]]
+
* [[Java EE]]
* [[PKI Client Java API]]
 
* [[PKI Client Python API]]
 
* [[TPS REST API]]
 
* [[Python Key Client]]
 
* [[Java Key Client]]
 
* [[Accessing PKI Services with curl]]
 
* [https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html RFC 2616]
 

Latest revision as of 21:14, 21 January 2021

Frameworks

PKI REST API

See PKI REST API Design.

References