C++ specific ones.
I found the following to be worth a watch Joshua Bloch - How To Design A Good API and Why it Matters. The examples are in Java though but still you can draw parallels. Since you didn't mention a specific technology ; I assume you don't want niche solutions.
awesome-guidelines - A curated list of high quality coding style conventions and standards. The F# Component Design Guidelines section contains recommendations for JSON API implementations; API Security Checklist - Checklist of the most important security countermeasures when designing, testing, and releasing
My favourite example of a well-design C API is GTK+ which uses method #2 that you describe. Although another advantage of your method #1 is not just that you could allocate the object on the stack, but also that you could reuse the same instance multiple times. If that's not going to be a common use case,
5 Apr 2010 However, as some APIs (amongst them pthreads) clearly demonstrate, designing a good C API is possible, if you follow a few rules. I don't claim to know all the can not be overemphasized. This is very important in programming in general, and in API design in particular. pthreads is great in this respect.
Standard Library Guidelines. These guidelines from the ISO C++ Library Working Group recommend conventions for writing the text (i.e. standardese) that describes components of the C++ standard library. If you are proposing a library component for standardization, you should follow these guidelines for proposed wording
7 Jul 2017 Six Characteristics of Good APIs. An API is to the programmer what a GUI is to the end-user. The 'P' in API stands for "Programmer", not "Program", to highlight the fact that APIs are used by programmers, who are humans. In his Qt Quarterly 13 article about API design, Matthias tells us he believes that APIs
19 Jun 2008 API considerations. And although the focus is on public APIs, there is no harm in applying the principles described here when writing application code or . 5. API design is, in many ways, like markup language design. An API is a language, or rather an extension to the programming language. The C++.
1 May 2016 It's 2016, and C APIs are as popular as always. Many libraries are written in C, or provide C APIs, and there are tons of bindings for any language making C the de-facto standard for portable APIs. Yet, a lot of C APIs fail basic design guidelines, and there doesn't seem to have been much progress in recent
6 Jul 2011 David Zeuthen has written a long and detailed article on many of the design issues that are faced when trying to write a plain C API. He deals with It's well worth a read if you are interested in writing a library in plain C (rather than C++). David's collection of best practices is split into 5 parts, as follows:.

Annons

The photo has no tags

March 2018