---
jsApi: true
title: "[P] JS Api"

---
## Index

### Enumerations

- [Visibility](Enumeration.Visibility.md)

### Interfaces

- [ApiKeyAuth](Interface.ApiKeyAuth.md)
- [AuthenticationOption](Interface.AuthenticationOption.md)
- [AuthorizationCodeFlow](Interface.AuthorizationCodeFlow.md)
- [BasicAuth](Interface.BasicAuth.md)
- [BearerAuth](Interface.BearerAuth.md)
- [ClientCredentialsFlow](Interface.ClientCredentialsFlow.md)
- [HeaderFieldOptions](Interface.HeaderFieldOptions.md)
- [HttpAuthBase](Interface.HttpAuthBase.md)
- [HttpOperation](Interface.HttpOperation.md)
- [HttpOperationBody](Interface.HttpOperationBody.md)
- [HttpOperationParameters](Interface.HttpOperationParameters.md)
- [HttpOperationRequestBody](Interface.HttpOperationRequestBody.md)
- [HttpOperationResponse](Interface.HttpOperationResponse.md)
- [HttpOperationResponseContent](Interface.HttpOperationResponseContent.md)
- [HttpServer](Interface.HttpServer.md)
- [HttpService](Interface.HttpService.md)
- [ImplicitFlow](Interface.ImplicitFlow.md)
- [MetadataInfo](Interface.MetadataInfo.md)
- [MetadataInfoOptions](Interface.MetadataInfoOptions.md)
- [OAuth2Scope](Interface.OAuth2Scope.md)
- [Oauth2Auth](Interface.Oauth2Auth.md)
- [OperationParameterOptions](Interface.OperationParameterOptions.md)
- [PasswordFlow](Interface.PasswordFlow.md)
- [PathParameterOptions](Interface.PathParameterOptions.md)
- [QueryParameterOptions](Interface.QueryParameterOptions.md)
- [RouteOptions](Interface.RouteOptions.md)
- [RoutePath](Interface.RoutePath.md)
- [RouteProducerResult](Interface.RouteProducerResult.md)
- [RouteResolutionOptions](Interface.RouteResolutionOptions.md)
- [ServiceAuthentication](Interface.ServiceAuthentication.md)

### Type Aliases

- [HttpAuth](Type.HttpAuth.md)
- [HttpOperationParameter](Type.HttpOperationParameter.md)
- [HttpVerb](Type.HttpVerb.md)
- [OAuth2Flow](Type.OAuth2Flow.md)
- [OAuth2FlowType](Type.OAuth2FlowType.md)
- [OperationContainer](Type.OperationContainer.md)
- [OperationDetails](Type.OperationDetails.md)
- [OperationVerbSelector](Type.OperationVerbSelector.md)
- [RouteProducer](Type.RouteProducer.md)
- [StatusCode](Type.StatusCode.md)

### Variables

- [$lib](Variable.$lib.md)
- [namespace](Variable.namespace.md)

### Functions

- [$body](Function.$body.md)
- [$delete](Function.$delete.md)
- [$get](Function.$get.md)
- [$head](Function.$head.md)
- [$header](Function.$header.md)
- [$includeInapplicableMetadataInPayload](Function.$includeInapplicableMetadataInPayload.md)
- [$onValidate](Function.$onValidate.md)
- [$patch](Function.$patch.md)
- [$path](Function.$path.md)
- [$plainData](Function.$plainData.md)
- [$post](Function.$post.md)
- [$put](Function.$put.md)
- [$query](Function.$query.md)
- [$route](Function.$route.md)
- [$server](Function.$server.md)
- [$sharedRoute](Function.$sharedRoute.md)
- [$statusCode](Function.$statusCode.md)
- [$useAuth](Function.$useAuth.md)
- [DefaultRouteProducer](Function.DefaultRouteProducer.md)
- [createMetadataInfo](Function.createMetadataInfo.md)
- [gatherMetadata](Function.gatherMetadata.md)
- [getAllHttpServices](Function.getAllHttpServices.md)
- [getAllRoutes](Function.getAllRoutes.md)
- [getAuthentication](Function.getAuthentication.md)
- [getContentTypes](Function.getContentTypes.md)
- [getHeaderFieldName](Function.getHeaderFieldName.md)
- [getHeaderFieldOptions](Function.getHeaderFieldOptions.md)
- [getHttpOperation](Function.getHttpOperation.md)
- [getHttpService](Function.getHttpService.md)
- [getOperationParameters](Function.getOperationParameters.md)
- [getOperationVerb](Function.getOperationVerb.md)
- [getPathParamName](Function.getPathParamName.md)
- [getPathParamOptions](Function.getPathParamOptions.md)
- [getQueryParamName](Function.getQueryParamName.md)
- [getQueryParamOptions](Function.getQueryParamOptions.md)
- [getRequestVisibility](Function.getRequestVisibility.md)
- [getResponsesForOperation](Function.getResponsesForOperation.md)
- [getRouteOptionsForNamespace](Function.getRouteOptionsForNamespace.md)
- [getRoutePath](Function.getRoutePath.md)
- [getRouteProducer](Function.getRouteProducer.md)
- [getServers](Function.getServers.md)
- [getStatusCodeDescription](Function.getStatusCodeDescription.md)
- [getStatusCodes](Function.getStatusCodes.md)
- [getVisibilitySuffix](Function.getVisibilitySuffix.md)
- [includeInapplicableMetadataInPayload](Function.includeInapplicableMetadataInPayload.md)
- [includeInterfaceRoutesInNamespace](Function.includeInterfaceRoutesInNamespace.md)
- [isApplicableMetadata](Function.isApplicableMetadata.md)
- [isApplicableMetadataOrBody](Function.isApplicableMetadataOrBody.md)
- [isBody](Function.isBody.md)
- [isContentTypeHeader](Function.isContentTypeHeader.md)
- [isHeader](Function.isHeader.md)
- [isMetadata](Function.isMetadata.md)
- [isOverloadSameEndpoint](Function.isOverloadSameEndpoint.md)
- [isPathParam](Function.isPathParam.md)
- [isQueryParam](Function.isQueryParam.md)
- [isSharedRoute](Function.isSharedRoute.md)
- [isStatusCode](Function.isStatusCode.md)
- [isVisible](Function.isVisible.md)
- [listHttpOperationsIn](Function.listHttpOperationsIn.md)
- [reportIfNoRoutes](Function.reportIfNoRoutes.md)
- [resolvePathAndParameters](Function.resolvePathAndParameters.md)
- [resolveRequestVisibility](Function.resolveRequestVisibility.md)
- [setAuthentication](Function.setAuthentication.md)
- [setRoute](Function.setRoute.md)
- [setRouteOptionsForNamespace](Function.setRouteOptionsForNamespace.md)
- [setRouteProducer](Function.setRouteProducer.md)
- [setSharedRoute](Function.setSharedRoute.md)
- [setStatusCode](Function.setStatusCode.md)
- [validateRouteUnique](Function.validateRouteUnique.md)
