# nestia-starter-api

> API for PROJECT

Latest version **0.0.0** (published 2023-05-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install nestia-starter-api
pnpm add nestia-starter-api
yarn add nestia-starter-api
bun add nestia-starter-api
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.0 |
| Published | 2023-05-30 |
| First published | 2023-05-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 27.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 19 |
| Author | AUTHOR |
| Maintainers | siwooh |

## Links

- npm: https://www.npmjs.com/package/nestia-starter-api
- Repository: https://github.com/samchon/nestia-template
- Homepage: https://github.com/samchon/nestia-template#readme
- Issues: https://github.com/samchon/nestia-template/issues
- npm.io page: https://npm.io/package/nestia-starter-api

## Dependencies (1)

- [@nestia/fetcher](https://npm.io/package/@nestia/fetcher.md) ^1.2.2

## Recent versions

- 0.0.0 (latest) — 2023-05-30

## README

# SDK for Client Developers
## Outline
[`nestia-starter`](https://github.com/samchon/nestia-template) provides SDK (Software Development Kit) for convenience.

For the client developers who are connecting to this backend server, [`nestia-starter`](https://github.com/samchon/nestia-template) provides not API documents like the Swagger, but provides the API interaction library, one of the typical SDK (Software Development Kit) for the convenience.

With the SDK, client developers never need to re-define the duplicated API interfaces. Just utilize the provided interfaces and asynchronous functions defined in the SDK. It would be much convenient than any other Rest API solutions.

```bash
npm install --save nestia-starter-api
```




## Usage
Import the `nestia-starter-api` and enjoy the auto-completion.

```typescript
import api from "@ORGINIZATION/PROJECT-api";

import { IBbsArticle } from "nestia-starter-api/lib/structures/bbs/IBbsArticle";

async function main(): Promise<void>
{
    //----
    // PREPARATIONS
    //----
    // CONNECTION INFO
    const connection: api.IConnection = {
        host: "http://127.0.0.1:37001",
    };

    const article: IBbsArticle = await api.functional.bbs.articles.store(
        connection,
        "general",
        {
            writer: "Robot",
            title: "Hello, world!",
            body: "Hello, I'm test automation robot",
            format: "txt",
            files: [
                {
                    name: "logo",
                    extension: "png",
                    url: "https://somewhere.com/logo.png",
                },
            ],
            password: "1234",
        },
    );
    typia.assertEquals(stored);

    const page: IPage<IBbsArticle> = await api.functional.bbs.articles.index(
        connection,
        "general",
        {
            limit: 100,
            search: {
                writer: "Robot"
            }
        }
    );
    await typia.assertEquals(page);
}
```

---
_Source: https://npm.io/package/nestia-starter-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._