Introduction

Welcome to the Tarin Documentation!

What is Tarin?

Tarin is a robust backend library for Node.js, purpose-built to streamline the definition of API endpoints while automatically generating API documentation in compliance with the OpenAPI Specification standard. It is specifically designed to enhance the efficiency of backend development using TypeScript and Node.js.

Key Features

• Compile-time and Runtime Input/Output Validation
  Ensures reliable API behavior with validation at both compile-time (via TypeScript autocompletion and type-checking) and runtime.

• Strongly Typed Endpoint Logic
  Simplifies endpoint implementation with strict input and output type enforcement for enhanced clarity and maintainability.

• Automated OpenAPI Documentation Generation
  Automatically generates API documentation that conforms to the OpenAPI Specification, reducing manual effort and ensuring accuracy.

How to Use These Docs

On the left side of the screen, you'll find the docs navbar. The pages of the docs are organized sequentially, from basic to advanced, so you can follow them step-by-step when building your application. However, you can read them in any order or skip to the pages that apply to your use case.

On the right side of the screen, you'll see a table of contents that makes it easier to navigate between sections of a page. If you need to quickly find a page, you can use the search bar at the top, or the search shortcut (Ctrl+K or Cmd+K).

To get started, check out the Installation guide.