apiit v1.2.0

Apiit

Library for creating an organized API layer

Api docs

Install

npm i apiit

Features

• Defining an endpoint as a reusable function
• Defining multiple hosts
• Ability to track request progress using events
• Possibility to cancel a request

Usage

• Create Host Instance - Defines a server object, allowing you to:

  • set headers
  • set base url
  • receive request events

  • receive error events

    import { createHost } from 'repository';
    
    const host = createHost("http://host.com");
    // or
    const hostSubpath = createHost("http://host.com/api");
    // or
    const siteSubpathAsHost = createHost("/api");

• Create endpoint

  • create

    host.createEndpoint('get', '/foo')

  • type RequestPayload = {
      filter: { name: string }
    }
    
    type ResponseData = {
      id: string
      name: string
    }
    host.createEndpoint<RequestPayload, ResponseData>('get', '/foo', {
      paramsConfig: {
        filter: {
          in: "query"
        }
      }
    })

  • type RequestPayload = {
      id: string
    }
    
    type ResponseData = {
      id: string
      name: string
    }
    
    host.createEndpoint<RequestPayload, ResponseData>('get', '/foo/:id', {
      paramsConfig: {
        id: {
          in: "path"
        }
      }
    })

  • host.createEndpoint('get', '/foo/:id', {
      paramsConfig: {
        id: {
          in: "path"
        }
      }
    })

  • type RequestPayload = {
      name: string
    }
    
    host.createEndpoint<RequestPayload, void>('post', '/foo', {
      paramsConfig: {
        name: {
          in: "body"
        }
      }
    })

• Endpoint Request

  • const endpoint = host.createEndpoint<RequestPayload, ResponseData>('get', '/foo', {
      paramsConfig: {
        filter: {
          in: "query"
        }
      }
    })
    
    const request = endpoint.request({
      filter: {
        type: 'bar'
      }
    });
    
    request.on(event, (payload) => {
      // code
    })

  • const response = await endpoint.request({
      filter: {
        type: 'bar'
      }
    }).getResult();

Proposed structure of the API layer

• <project src>
  • api

    • hosts

      • apiHost.ts

        import { createHost } from 'repository';
        
        const headers = {
          'Header': 'string',
          'Header 2': () => 'string'
        }
        
        const host = createHost("http://host.com", headers);
        
        export default host;

    • <subject entity>

      • types.ts - entity types

      • or methods.ts

        import apiHost from '@/api/hosts/apiHost'
        import type { EntityType } from './types.ts'
        
        const entityEndpoint = apiHost.createEndpoint<FiltersType, EntityType[]>(/* endpoint config */);
        
        export { entityEndpoint };

      • or <entity action><Entity name>.ts

        import apiHost from '@/api/hosts/apiHost'
        
        const entityEndpoint = apiHost.createEndpoint(/* endpoint config */);
        
        export default entityEndpoint;

      • index.ts

        export * from './methods.ts'
                         // or
        export { default as entityAction } from './entityAction.ts'