Find Jobs
Hire Freelancers

Automate documentation generation for Swagger

$30-250 USD

Cerrado
Publicado hace más de 2 años

$30-250 USD

Pagado a la entrega
We have inline documentation in our project, in the source code itself, here is an example: /* * @api [get] /todo/{id} * description: "Get a todo" * parameters: * - (path) todo_id= {Int} * responses: * "200": * description: todo object */ const authGet = async function (req: Request, res: Response, next: NextFunction) { const id = parseInt([login to view URL]); if (isNaN(id)) { send_failure(400, res, { reason: 'invalid todo_id' }); return; } ... } We are using a tool called swagger-inline for nodejs which generates this documentation: [login to view URL] We are not really happy about this, as the documentation isn't properly generated. It also doesnt look pretty. From you we need: 1. Standardise our documentation generation from inline code 2. Create a method for us to use when publishing our code for production which automatically generates our API documentation (CI) 3. Make our documentation look more pretty and professional 4. Give us guidelines on how to properly document all our endpoints for POST, GET, PUT, DELETE 5. Help us migrate all our existing documentation and in the end have a nice API documentation 6. Show us examples of how it may look before you proceed to work All our code is written in TypeScript and we are using Node.js as backend, npm (or yarn).
ID del proyecto: 32887902

Información sobre el proyecto

6 propuestas
Proyecto remoto
Activo hace 2 años

¿Buscas ganar dinero?

Beneficios de presentar ofertas en Freelancer

Fija tu plazo y presupuesto
Cobra por tu trabajo
Describe tu propuesta
Es gratis registrarse y presentar ofertas en los trabajos
6 freelancers están ofertando un promedio de $135 USD por este trabajo
Avatar del usuario
Hello. How are you? I hope you are well and I can provide the best documentation of our project. I have 6+years experience with backend development. And I will manage all feedback without any payment. Please message me. Thanks. Regards.
$140 USD en 7 días
5,0 (1 comentario)
2,9
2,9
Avatar del usuario
Hi! This is a part of my last work's swagger.json. ex: "paths": { "/candidate":{ "post":{ "summary": "This route is used to create a candidate.", "tags": ["Candidates"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#components/schemas/Candidate" }, "example":{ "candidate": { "value": { "firstname": "Jane", "lastmane": "Doe", "username": "janedoe", "password": "1234" } } } } } }, "responses":{ "200":{ "description": "Candidate created." }, "400":{ "description": "Error to created." } } } }
$150 USD en 7 días
5,0 (2 comentarios)
2,7
2,7
Avatar del usuario
Hi, I see that you need some assistant in Automate documentation generation for Swagger I have skills in: C,C#,C++,JAVA and I have experience in web development. I have skills with the following programming languages: C, "C ++", "C #", Python, GO, Matlab, Java, VB, kotlin, JavaScript. Web development skills: Full-stack, Front-End, Back-End, Responsive Design. - Angular, React, Jquery, Ajax - Bootstrap, CSS3, Less, Sass, Scss, Responsive, Material. - JSON, XML. Skills with the following web languages: - PHP, NET CORE, Aspx, HTML5, JSP, RUBY. I would be glad if the opportunity of doing this task can be given to me. i'll await your message to have more discussion with you on the project. Kindly check my profile https://www.freelancer.com/u/mzdesmag to see my past works and reviews. Thanks.
$130 USD en 3 días
5,0 (1 comentario)
2,2
2,2
Avatar del usuario
Hi there, My name is Umair. I have good experience with Node.js. I am a practicing Developer/Designer Since 2015. I can perfectly work on this project regarding Node.js. Based on my experience, I can do this task for you and the quality of work would be up to the mark. However, further discussions are required for more clarity. I will wait for your text to discuss the project in further detail. Thanks & Regards Umair A.
$150 USD en 10 días
0,0 (0 comentarios)
0,0
0,0

Sobre este cliente

Bandera de SWEDEN
Stockholm, Sweden
5,0
5
Forma de pago verificada
Miembro desde may 27, 2019

Verificación del cliente

¡Gracias! Te hemos enviado un enlace para reclamar tu crédito gratuito.
Algo salió mal al enviar tu correo electrónico. Por favor, intenta de nuevo.
Usuarios registrados Total de empleos publicados
Freelancer ® is a registered Trademark of Freelancer Technology Pty Limited (ACN 142 189 759)
Copyright © 2024 Freelancer Technology Pty Limited (ACN 142 189 759)
Cargando visualización previa
Permiso concedido para Geolocalización.
Tu sesión de acceso ha expirado y has sido desconectado. Por favor, inica sesión nuevamente.