API Extractor
API Extractor is a tool for analyzing TypeScript program files and emitting .api.json files with information about the API surface of the program.
documentation
typescript
api
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
Simplifies the process of documenting and understanding TypeScript APIs
Generates structured data that can be easily consumed by other tools
Supports a wide range of TypeScript language features
Provides a consistent and standardized way to extract API information
Cons
Requires additional setup and configuration for complex projects
May not capture all nuances of the API surface, especially for dynamic or advanced TypeScript features
Limited customization options compared to more comprehensive documentation tools
Official Links
The Best API Extractor Alternatives
Top Development and Api Management and other similar apps like API Extractor
Ng-docx
ng-docx is an open-source JavaScript library for dynamically generating Word (.docx) documents. It provides an AngularJS service that allows creating Word documents on the client-side or server-side.Some key features of ng-docx include:Generates Word documents with text, images, tables, lists, headers, footers, page numbers, etc.Supports AngularJS data binding to populate documents...
Docma
Docma is an open-source document management system that helps businesses and teams organize, store, search and share important files. It has functionality including:Centralized document storage - Store all files such as documents, images, PDFs etc. in one searchable repository.Indexing and fast search - Automatically indexes files for quick searching by...
ESDoc
ESDoc is an open source documentation generator for JavaScript projects. It analyzes JavaScript source code comments and generates an HTML website displaying API documentation from those comments.Key features of ESDoc include:Supports ES2015+ syntax including classes, decorators, async/await etc.Generates documentation for classes, methods, parameters, events, typedefs and more based on JSDoc-style...
