@backan/core
Advanced tools
All in one web API builder.
BACKAN Create endpoints with type validations and OpenApi documentation, safely and quickly.
This package contains BACKAN Core library
App instaceRouteEndpointsbackan built with?BackanBackan serverStart building your restAPI app now 🌈.
npm install backan
pnpm i backan
yarn add backan
corenpm install @backan/core
pnpm i @backan/core
yarn add @backan/core
You can automatically create a backan template with:
npm create backan
pnpm create backan
yarn create backan
App instaceRouteEndpoints
BACKAN is a library designed to build REST API applications quickly and easily.
[!IMPORTANT] Currently in phase
BetaThe library can be used perfectly in production, but could undergo changes and new features until version1. To avoid ongoing maintenance issues, we recommend installing a fixed version (without^) in your project.
Our project is not intended to be a substitute for any web framework. Our library aims to cover a specific use case, that of building APIs, simplifying this process as much as possible and creating APIs in a robust way.
The creation of this project is also due to the need of our collective to create APIs with good documentation and in a simple way, an example of this is the Api section of bepp (a web extension packager).
data validation, so that your endpoints are as secure as possible and reduce repetitive code (boilerplate).automatic OpenAPI documentation, improving the visibility of our API without the need to import other projects.In addition, BACKAN also provides:
[!note] The documentation is under construction. Soon, we will write all the points it contains
backan built with?Our library is built under the hono framework, which is why you will see references to it in our documentation and our code. BACKAN is an implementation that aims to simplify the construction of apirest for specific use cases.
You want to build an apirest quickly and safely and without thinking about third-party implementations, well here we propose our alternative.
BackanStart building your restAPI app now 🌈.
Backan serverThe backan builder library allows you to build multiple things. Among others:
Executables / binaries: Create binaries of your project for all systems and architectures with zero config.Client library: Create a client to facilitate the implementation of the API in a frontend or other service.JSON schema file: Export the OpenAPI schema to a JSON file.TypeScript definitions file: Export OpenAPI schema to a d.ts file.Markdown documentation: Build your application documentation in a Markdown file.BACKAN is an open-source project and its development is open to anyone who wants to participate.
Help us to develop more interesting things.
This software is licensed with GPL-3.0.
PigeonPosse is a ✨ code development collective ✨ focused on creating practical and interesting tools that help developers and users enjoy a more agile and comfortable experience. Our projects cover various programming sectors and we do not have a thematic limitation in terms of projects.
| Name | Role | GitHub | |
|---|---|---|---|
 | Angelo | Author & Development | @Angelo |
 | PigeonPosse | Collective | @PigeonPosse |
FAQs
All in one web API builder. Create endpoints with type validations and OpenApi documentation, safely and quickly.
The npm package @backan/core receives a total of 17 weekly downloads. As such, @backan/core popularity was classified as not popular.
We found that @backan/core demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.
