realtime-document
v0.0.6
Published
This module gives you a user interactive component to give developers or your coworkers a graphical UI to test your api and give them information about the documentation of your application. Our goal is to make documentation much easier for developers but
Downloads
13
Readme
Realtime API Documentator
This module gives you a user interactive component to give developers or your coworkers a graphical UI to test your api and give them information about the documentation of your application. Our goal is to make documentation much easier for developers but we are not auto generated document or aiming to cover details of code, just imagine a more configurable swagger.
Installing and usage
This is package is a set of useful components, but you need to create your own angular app to use these components. To install from npm:
npm install realtime-document
then, go to your app.module
and add these lines:
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { RealtimeDocumentModule } from 'realtime-document'; // You need this line
import { AppComponent } from './app.component';
@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
RealtimeDocumentModule // You need this line
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule { }
Using inline api controller
When you want to document an api, you can use rd-inline-api component:
<rd-inline-api
type="post"
url="https://jsonplaceholder.typicode.com/posts"
></rd-inline-api>
It will show up with ability to run the api.
Live demo
You can see live demo and examples here, and it will inspire you how to build your own documentations.
https://owsolutions.github.io/realtime-document