Comment

Comment concevoir une API facile à utiliser

Comment concevoir une API facile à utiliser

Une API est une INTERFACE DE PROGRAMMATION D'APPLICATION. C'est une interface qui vous aide à programmer pour le programme de quelqu'un d'autre. L'API de Twitter permet aux gens de créer des applications Twitter.

Twitter fournit aux créateurs d'applications certaines CLASSES, FONCTIONS et VARIABLES afin qu'ils puissent les utiliser pour interagir avec le site Web de Twitter. Toute application pouvant publier sur Twitter utilise l'API Twitter.

API Twitter

Référence de script UNITY 3D (leur API est tout aussi déroutante)

Non, merci.

Celui-ci est conçu par les développeurs de CODEA APP. Un peu mieux.

Un problème majeur avec la plupart des API est que la façon dont elles nomment leurs variables, leurs fonctions et leurs classes n'est pas intuitive.

À peu près toutes les API que j'ai essayé d'utiliser ont une configuration très déroutante et non organisée. Et il est difficile de trouver facilement tout ce que je veux. J'ai donc pensé à une manière plus soignée d'afficher une API aux utilisateurs.

Au lieu d'utiliser un format OUTLINE, il est préférable d'utiliser un format TABLE pour votre API. L'organisation des CLASSES, FONCTIONS ET VARIABLES en tableaux est plus facile à lire qu'un plan avec plusieurs liens.

Je vais créer un exemple d'API GAME ENGINE

Ceci est une CLASSE D'ANIMATION. À l'intérieur se trouvent trois fonctions. JUMP, MOVE et SPIN sont les trois fonctions. Rendez les noms de fonctions faciles à comprendre. Je peux facilement dire ce que font ces fonctions.

En cliquant sur la fonction MOVE, vous accédez à une autre table.

REMARQUE: Un point à la fin d'un mot signifie qu'il s'agit d'une CLASSE. Un point au début d'un mot signifie qu'il fait partie d'une classe.

À l'intérieur de la fonction MOVE se trouvent plusieurs variables. Le bouton, la direction, la vitesse, l'animation et le son sont les variables à l'intérieur de la fonction MOVE. Vous pouvez également ajuster les variables du tableau.

En tant que phrase, cette fonction serait "Déplacer, en utilisant le bouton" DROITE "dans la direction" 0 "avec une vitesse de" 4 "tout en jouant l'animation" marcher "et le son" marcher "."

C'est la fonction JUMP

Et c'est la fonction SPIN. Remarquez comment LOOP est une variable BOOLEAN. SPEED est une variable FLOAT.

Les jeux comportent plusieurs éléments clés. La classe ANIMATION anime des trucs.

La classe sonore gère les sons. Cette classe a une variable SOUND et une variable LOOP. Il dispose également d'une fonction PLAY et d'une fonction STOP.

Nous avons besoin d'objets dans le jeu pour donner des animations et des sons.

CLASSE D'OBJET. Les objets statiques ou non intelligents doivent faire partie de la classe OBJECT.

Et nous avons besoin de PERSONNAGES. Ce sont des objets très avancés. Ce sont des objets intelligents.

CLASSE DE PERSONNAGE.

LUMIÈRES.CAMÉRAS.ACTION.

CLASSE LÉGÈRE

CLASSE DE CAMÉRA

CLASSE CUTSCENE

Chaque jeu a un menu!

CLASSE DE MENU

Maintenant, nous mettons nos objets animés avec son et lumières dans un NIVEAU!

CLASSE DE NIVEAU. Voyez comment les objets sont déjà organisés par leur CLASSE? Le son "STUDIO" est de la classe "LIGHTS". LUMIÈRES DE STUDIO!

Rassemblez tout cela avec une CLASSE D'HISTOIRE

La CLASSE STORYBOARD est comme le CENTRE DE CONTRÔLE de votre jeu ou moteur de jeu. Il organise les événements de votre jeu. Donc ce jeu a un CUSTSCENE suivi d'un MENU puis d'un NIVEAU.

Vous pouvez également mettre des commentaires au bas de vos tableaux avec des informations détaillées sur le fonctionnement des choses.

Bien sûr, vos informations seraient plus détaillées. Peut-être que quelques exemples sur le fonctionnement des classes seraient inclus.


Voir la vidéo: Créer une API avec Laravel (Décembre 2021).