2012-02-27 9 views
18

Estoy aprendiendo cómo asignar e incrementar números de versión con la regla llamada "Versiones semánticas" desde http://semver.org/.¿Qué significa "API pública" en versiones semánticas?

Entre todas sus reglas, el primero dijo:

software de versiones usando semántica debe declarar una API pública. Esta API podría declararse en el código mismo o existir estrictamente en la documentación. Sin embargo se hace, debe ser precisa y completa"

Estoy confundido acerca de 'API pública'. ¿Qué se refiere?

+0

El sitio http://semver.org/ parece explicar en pocas palabras lo que significa. ¿O es la faceta "API" o "pública" lo que no entiendes? Y su pregunta probablemente pertenece a http://programmers.stackexchange.com/ –

+1

@BasileStarynkevitch, parece que se ha respondido allí: http://programmers.stackexchange.com/questions/255190/how-does-semantic-versioning- apply-to-programs-without-api – icc97

Respuesta

5

API pública se refiere al 'punto de acceso' que la externa mundo (usuarios, otros programas y/o programadores, etc.) a su software.

Por ejemplo, si está desarrollando una biblioteca, la API pública es el conjunto de todos los métodos invokations que se pueden hacer a su biblioteca

Se entiende que, a menos que una versión principal cambie, su API w será compatible con versiones anteriores, es decir, todas las llamadas válidas en una versión serán válidas en una versión posterior. Usted puede leer en el punto 9 de estas reglas:

Major versión X (x.y.z | X> 0) se debe aumentar si se introducen cambios hacia atrás incompatibles con la API pública.

+2

Esta respuesta no está completa: Public API también se refiere a la documentación pública de dicha biblioteca. El comportamiento documentado también es algo en lo que uno debe poder confiar. – ereOn

1

Requiere una API pública para aplicar efectivamente su patrón de control de versiones.

Por ejemplo:

Corrección de errores no afectan a la API incrementan la versión del parche

adiciones API compatible hacia atrás/cambios de la subasta la versión menor , y ...

API revés incompatibles los cambios incrementan la versión principal.

Lo que representa su API es subjetiva, ya que incluso en el estado doc SemVer:

Esto puede consistir en la documentación o ser aplicada por el propio código.

Cuestiones relacionadas