API Extractor
ApiExtractor: Analyze TypeScript Programs
Extract .api.json files with API surface information from TypeScript program files, a powerful tool for analyzing and documenting your codebase.
What is API Extractor?
API Extractor is an open-source tool developed by Microsoft to help track and manage public APIs in TypeScript libraries. It analyzes TypeScript code to detect exported symbols, validates documentation comments, and emits an .api.json file containing metadata about the library's API surface.
Some key features of API Extractor include:
- Detects classes, interfaces, enums, functions, etc. that are exported from TypeScript code
- Validates JSDoc comments and ensures documentation stays in sync with code
- Emits a machine-readable .api.json file containing API surface metadata
- Integrates with API review tools like api-documenter to generate documentation
- Configurable to handle complex project structures with multiple packages
- Helps identify and track API changes and stability over time
By using API Extractor, TypeScript library authors can define their public API surface, validate documentation coverage, and produce human-readable documentation pages. It improves maintainability and catches API changes early during development.
API Extractor Features
Features
- Analyzes TypeScript program files
- Emits .api.json files with information about the API surface of the program
- Supports various output formats including JSON, XML, and Markdown
- Allows for customization of the extraction process through configuration files
- Provides options for filtering and excluding specific API elements
Pricing
- Open Source
Pros
Cons
Official Links
Reviews & Ratings
Login to ReviewThe Best API Extractor Alternatives
View all API Extractor alternatives with detailed comparison →
Top Development and Api Management and other similar apps like API Extractor
Ng-docx
Docma
ESDoc
