Api Doc - SDK - 02 - Create a Doc


Create documentation

Para criar uma nova documentação, basta chamar o método “createNewApiDoc”, onde será necessário passar o “ID” do usuário e um payload, contendo o objeto a ser criado,
abaixo segue um exemplo de como criar o objeto e a estrutura do payload.

The Payload

{
  "apiName": "Api Test",
  "descriptionApi": "This Api is an Test",
  "version": "v1.0.0",
  "email": "email@teste.com",
  "license": "MIT",
  "isPublic": true,
  "baseURL": "http://localhost:3000"
}

The Method

async function store() {
  try {
    await apiDoc.createNewApiDoc(userId, payload);
    console.log('sucess')
  } catch (error) {
    console.log(error.message)
  }
}

// Then/Catch
apiDoc
  .createNewApiDoc(payload)
  .thec((resp) => {
    console.log(resp);
  })
  .catch((err) => {
    console.log(err.message);
  });

About Security

Observem que a SDK não se preocupa com autenticação, as regras de autenticação devem ficar na camada da API da sua aplicação e podem ser modificadas de acordo com seu modelo de aplicação, isso foi feito propositalmente para que a SDK pudesse ser utilizada de forma mais ampla.


Author: João Medeiros
Reprint policy: All articles in this blog are used except for special statements CC BY 4.0 reprint polocy. If reproduced, please indicate source João Medeiros !
  Topics