Documentation: Enough Already! Not.

Mike McCoy Consulting, Other, Problem Solving, Soft Skills Leave a Comment

Documentation. I know we all hate having to create it. I don’t like writing it and feel like I always leave something out. However, our assumptions of what other developers should think we are trying to accomplish by our masterpieces of software are usually filled with potholes (sometimes big ones). The truth of the matter is that no matter how stellar your code or software is – if you’re the only one who understands how it works, it doesn’t do any good.

These are not paintings or sculptures that would live the rest of their days in a museum, untouched by human hands and just collecting dust as they run. In reality, documentation will be added to and changed as the information they describe evolves.

In this blog, we discuss two suggested strategies for the creation of useful and concise software documentation.

Angular and Swagger: Experiences Learned

RJ Dela-Cruz Angular, JavaScript, Technology Snapshot 1 Comment

Recently I was fortunate enough to be a part of a project where we were building an application from scratch into an Angular front-end application with Microservices in the back end. Swagger was used as the contract between the UI and Microservices.

In this blog, I talk about the things I learned from this project experience, like how to use Swagger to define the endpoints of the Microservices, integrating Swagger-generated code into Angular, and working with configuration (including oAuth2 tokens), among other “gotchas…”

Give Enterprise APIs Visibility With Swagger And GrokOla

Lauren Fournier Company News, Keyhole Creations Leave a Comment

The Keyhole Labs team is excited to announce that GrokOla now offers Swagger integration. GrokOla users can now upload Swagger JSON files into GrokOla to have all API documentation centralized, searchable, and accessible from within their private GrokOla instance. Additionally, there an integration API that allows Swagger JSON to be uploaded automatically to GrokOla with a RESTful API. This allows continuous …

What They Didn’t Teach Me In College

Robert Rice Programming Leave a Comment

I attained my IT degree (B. S. in Computer Science) 12+ years ago at a traditional midwestern college, so the education was fairly well rounded. Looking back more than a decade later (having gained a not insignificant amount of real-world experience), there are certain bits of information that, since they were lacking in the classroom, left my well-rounded education with …