@apideck/portman
Version:
Port OpenAPI Spec to Postman Collection, with contract & variation tests included
31 lines (30 loc) • 1.35 kB
TypeScript
import { Collection, CollectionDefinition, Item, ItemGroup } from 'postman-collection';
import { IOpenApiParser } from '../oas/OpenApiParser';
import { PostmanMappedOperation } from './PostmanMappedOperation';
export interface PostmanParserConfig {
inputFile?: string;
collection?: Collection;
oasParser?: IOpenApiParser;
}
export interface IPostmanParser {
collection: Collection;
mappedOperations: PostmanMappedOperation[];
pmItems: Item[];
getOperationById(operationId: string): PostmanMappedOperation | null;
getOperationByPath(path: string): PostmanMappedOperation | null;
}
export declare class PostmanParser implements IPostmanParser {
collection: Collection;
mappedOperations: PostmanMappedOperation[];
pmItems: Item[];
private oasParser?;
constructor(options: PostmanParserConfig);
map(collection?: CollectionDefinition): void;
getItems: (item: Item | ItemGroup<Item>) => void;
itemsToOperations: () => void;
getOperationByPath(path: string): PostmanMappedOperation | null;
getOperationById(operationId: string): PostmanMappedOperation | null;
getOperationsByIds(operationIds: string[]): PostmanMappedOperation[];
getOperationByItemId(itemId: string | undefined): PostmanMappedOperation | null;
getOperationsByPath(path: string): PostmanMappedOperation[];
}